APIリファレンス
GDWebWriter
GD.web.streamに渡した関数が受け取る出力先です。write(data, offset=0, count=-1)は指定範囲のバイト列を送り、受け付けたバイト数を返します。write_text(text, offset=0, count=-1)は指定範囲の文字列をUTF-8に変換して送ります。count=-1は残りすべてです。送信先が受け取れない間は待ちます。flushは、それまでに書き込んだデータの送信完了を待ちます。切断はflushのエラーやリクエストのキャンセルで確認できます。
メソッド
write(data: PackedByteArray, offset: int = 0, count: int = -1) -> int, Errwrite_async(data: PackedByteArray, offset: int = 0, count: int = -1) -> await int, Errwrite_text(text: String, offset: int = 0, count: int = -1) -> int, Errwrite_text_async(text: String, offset: int = 0, count: int = -1) -> await int, Errflush() -> int, Errflush_async() -> await int, Err
write
write(data: PackedByteArray, offset: int = 0, count: int = -1) -> int, Err英語原文Wait behind preceding writes without ending the response.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
data | PackedByteArray | 省略不可 | 処理するデータ。上に示した引数の型に合わせて渡します。 |
offset | int | 0 | 0から数える開始位置。文字列の文字位置を扱うメソッド以外はバイト単位。 |
count | int | -1 | 開始位置から処理する要素数。対応する操作では-1が残り全体を示します。 |
戻り値
int, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
write_async
write_async(data: PackedByteArray, offset: int = 0, count: int = -1) -> await int, Err英語原文Expose an explicit asynchronous flush completion.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
data | PackedByteArray | 省略不可 | 処理するデータ。上に示した引数の型に合わせて渡します。 |
offset | int | 0 | 0から数える開始位置。文字列の文字位置を扱うメソッド以外はバイト単位。 |
count | int | -1 | 開始位置から処理する要素数。対応する操作では-1が残り全体を示します。 |
戻り値
await int, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
write_text
write_text(text: String, offset: int = 0, count: int = -1) -> int, Err英語原文Encode a character range and return accepted UTF-8 bytes with normal write backpressure.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
offset | int | 0 | 書き込みを始める文字の位置。UTF-8に変換する前の文字列の先頭を0として数えます。 |
count | int | -1 | エンコードする文字数。-1は残り全体。 |
戻り値
int, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
write_text_async
write_text_async(text: String, offset: int = 0, count: int = -1) -> await int, Err英語原文Expose text write completion as a signal.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
offset | int | 0 | 書き込みを始める文字の位置。UTF-8に変換する前の文字列の先頭を0として数えます。 |
count | int | -1 | エンコードする文字数。-1は残り全体。 |
戻り値
await int, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
flush
flush() -> int, Err英語原文Wait behind preceding writes without ending the response.
引数
引数はありません。
戻り値
int, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
flush_async
flush_async() -> await int, Err英語原文Expose an explicit asynchronous flush completion.
引数
引数はありません。
戻り値
await int, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。