APIリファレンス
GDGzipWriter
データを少しずつgzip圧縮し、ファイルや接続、HTTPレスポンスへ出力します。writeは受け付けた入力バイト数を返し、flushは途中までのデータを出力し、closeは圧縮を完了します。操作は受付順に行い、エラーはresetまで残ります。呼び出した処理だけが完了を待ちます。Signalを受け取ってあとで待つ場合は_async付きの関数を使います。
プロパティ
header: Dictionary
メソッド
set_header(header: Dictionary) -> voidwrite(data: PackedByteArray) -> int, Errwrite_async(data: PackedByteArray) -> await int, Errflush() -> Variant, Errflush_async() -> await Variant, Errclose() -> Variant, Errclose_async() -> await Variant, Errreset(writer: RefCounted) -> Variant, Errreset_async(writer: RefCounted) -> await Variant, Err
set_header
set_header(header: Dictionary) -> void英語原文Set metadata for the next unstarted member.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
header | Dictionary | 省略不可 | 圧縮メンバーの開始前に設定するname・comment・extra・mod_time・osのメタデータ。 |
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
write
write(data: PackedByteArray) -> int, Err英語原文Compress bytes and return the accepted input count.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
data | PackedByteArray | 省略不可 | 処理するデータ。上に示した引数の型に合わせて渡します。 |
戻り値
int, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
write_async
write_async(data: PackedByteArray) -> await int, Err英語原文Compress bytes and return the accepted input count.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
data | PackedByteArray | 省略不可 | 処理するデータ。上に示した引数の型に合わせて渡します。 |
戻り値
await int, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
flush
flush() -> Variant, Err英語原文Flush compressed output without ending the member.
引数
引数はありません。
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
flush_async
flush_async() -> await Variant, Err英語原文Flush compressed output without ending the member.
引数
引数はありません。
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
close
close() -> Variant, Err英語原文Finish the member without closing the destination.
引数
引数はありません。
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
close_async
close_async() -> await Variant, Err英語原文Finish the member without closing the destination.
引数
引数はありません。
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
reset
reset(writer: RefCounted) -> Variant, Err英語原文Discard stream state and reuse the compressor at the same level.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
writer | RefCounted | 省略不可 | write操作を持つバイト列の出力先。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
reset_async
reset_async(writer: RefCounted) -> await Variant, Err英語原文Discard stream state and reuse the compressor at the same level.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
writer | RefCounted | 省略不可 | write操作を持つバイト列の出力先。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。