gdドキュメント0.8.0

APIリファレンス

GDFileStream

ファイルを少しずつ読み書きするオブジェクトです。同じファイルストリームへの操作は受付順に進み、別のストリームは並行して処理できます。使い終わったらclose()で閉じます。

メソッド

read

read(max: int = 32768) -> PackedByteArray, Err
英語原文

Read up to the requested bytes; an empty success result denotes EOF when the requested count is positive.

引数

名前型省略時の値説明
maxint327681回の読み取りで要求する最大バイト数。

戻り値

PackedByteArray, Err

この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

read_async

read_async(max: int = 32768) -> await PackedByteArray, Err
英語原文

Read up to the requested bytes; an empty success result denotes EOF when the requested count is positive.

引数

名前型省略時の値説明
maxint327681回の読み取りで要求する最大バイト数。

戻り値

await PackedByteArray, Err

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

write

write(data: PackedByteArray) -> int, Err
英語原文

Write all supplied bytes and return the written count.

引数

名前型省略時の値説明
dataPackedByteArray省略不可処理するデータ。上に示した引数の型に合わせて渡します。

戻り値

int, Err

この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

write_async

write_async(data: PackedByteArray) -> await int, Err
英語原文

Write all supplied bytes and return the written count.

引数

名前型省略時の値説明
dataPackedByteArray省略不可処理するデータ。上に示した引数の型に合わせて渡します。

戻り値

await int, Err

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

seek

seek(offset: int) -> Variant, Err
英語原文

Move the next I/O position to a byte offset from the start.

引数

名前型省略時の値説明
offsetint省略不可0から数える開始位置。文字列の文字位置を扱うメソッド以外はバイト単位。

戻り値

Variant, Err

この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

seek_async

seek_async(offset: int) -> await Variant, Err
英語原文

Move the next I/O position to a byte offset from the start.

引数

名前型省略時の値説明
offsetint省略不可0から数える開始位置。文字列の文字位置を扱うメソッド以外はバイト単位。

戻り値

await Variant, Err

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

close

close() -> Variant, Err
英語原文

Close the file after preceding operations.

引数

引数はありません。

戻り値

Variant, Err

この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

close_async

close_async() -> await Variant, Err
英語原文

Close the file after preceding operations.

引数

引数はありません。

戻り値

await Variant, Err

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

is_open

is_open() -> bool
英語原文

Return whether the file has been opened and closing has not started.

引数

引数はありません。

戻り値

bool

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。