gdドキュメント0.8.0

APIリファレンス

GD.data

バイト列、データ形式の変換、ハッシュ、鍵の生成を扱います。CSV・INI・TOML・YAML・JSON・XMLなどをメモリ上で変換できます。不正な入力や設定はエラーとして返します。

メソッド

gzip_writer

gzip_writer(writer: RefCounted, level: int = -1) -> GDGzipWriter, Err

バイト列の出力先に書き込むGDGzipWriterを作ります。圧縮は別スレッドで行い、出力先が受け取れる量に合わせて待ちます。levelは-2(Huffmanのみ)、-1(既定値)、0〜9を指定できます。closeはgzipデータを完成させますが、出力先は閉じません。resetで同じ圧縮レベルのまま再利用できます。

引数

名前型省略時の値説明
writerRefCounted省略不可write操作を持つバイト列の出力先。
levelint-1圧縮レベル。-2はHuffmanのみ、-1は既定、0から9は圧縮レベル。

戻り値

GDGzipWriter, Err

エラー

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

csv

csv(src: String, sep: String = ",") -> Array, Err
英語原文

Read and write in-memory document formats.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。
sepString","レコードやフィールドの分割・連結に使う区切り。

戻り値

Array, Err

エラー

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

to_csv

to_csv(rows: Array, sep: String = ",") -> String
英語原文

Encode rows as delimited text, quoting fields that contain separators, quotes, or line endings.

引数

名前型省略時の値説明
rowsArray省略不可入力順の行。データベースの一括実行では各行が1組のパラメーターです。
sepString","レコードやフィールドの分割・連結に使う区切り。

戻り値

String

エラー

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

csv_objects

csv_objects(src: String, sep: String = ",") -> Array, Err
英語原文

Parse delimited text using its first row as field names for the remaining object rows.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。
sepString","レコードやフィールドの分割・連結に使う区切り。

戻り値

Array, Err

エラー

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

to_csv_objects

to_csv_objects(items: Array, sep: String = ",") -> String
英語原文

Encode object rows as delimited text with a header row naming their fields.

引数

名前型省略時の値説明
itemsArray省略不可変換・収集する入力要素を元の順番で並べたもの。
sepString","レコードやフィールドの分割・連結に使う区切り。

戻り値

String

エラー

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

ini

ini(src: String) -> Dictionary, Err
英語原文

Parse sectioned key-value text into a dictionary.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

Dictionary, Err

エラー

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

to_ini

to_ini(data: Dictionary) -> String
英語原文

Serialize a dictionary as sectioned key-value text.

引数

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

戻り値

String

エラー

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

toml

toml(src: String) -> Dictionary, Err
英語原文

Parse configuration text into its structured values and report malformed input.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

Dictionary, Err

エラー

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

to_toml

to_toml(data: Dictionary, prefix: String = "") -> String, Err

変換した値とErrを返します。変換先の形式で表せない値がある場合は、その値を省略せずにエラーを返します。

引数

名前型省略時の値説明
dataDictionary省略不可処理するデータ。上に示した引数の型に合わせて渡します。
prefixString""エンコードしたテーブルの前に付けるパスの接頭辞。

戻り値

String, Err

エラー

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

yaml

yaml(src: String) -> Variant, Err
英語原文

Parse indentation-based document text into structured values and report malformed input.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

Variant, Err

エラー

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

to_yaml

to_yaml(data: Variant, depth: int = 0) -> String, Err

変換した値とErrを返します。変換先の形式で表せない値がある場合は、その値を省略せずにエラーを返します。

引数

名前型省略時の値説明
dataVariant省略不可処理するデータ。上に示した引数の型に合わせて渡します。
depthint0データを文字列に変換するときの、入れ子や字下げの開始位置。

戻り値

String, Err

エラー

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

jsonc

jsonc(src: String) -> Variant, Err
英語原文

Decode JSON text permitting comments and trailing commas.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

Variant, Err

エラー

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

strip_jsonc

strip_jsonc(src: String) -> String
英語原文

Remove comments and trailing commas from JSON-like text before strict decoding.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

String

エラー

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

jsonl

jsonl(src: String) -> Array, Err
英語原文

Decode newline-delimited JSON records into an array; malformed records return an error.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

Array, Err

エラー

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

to_jsonl

to_jsonl(items: Array) -> String, Err
英語原文

Encode each supplied value as one JSON record terminated by a newline.

引数

名前型省略時の値説明
itemsArray省略不可変換・収集する入力要素を元の順番で並べたもの。

戻り値

String, Err

エラー

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

jsonl_reader

jsonl_reader() -> GDJSONLReader
英語原文

Create a sequential JSON Lines reader.

引数

引数はありません。

戻り値

GDJSONLReader

エラー

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

front_matter

front_matter(src: String) -> Dictionary, Err
英語原文

Split document metadata from the body and parse its declared metadata format.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

Dictionary, Err

エラー

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

has_front_matter

has_front_matter(src: String) -> bool
英語原文

Return whether the document begins with a recognized metadata delimiter.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

bool

エラー

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

to_front_matter

to_front_matter(attrs: Dictionary, body: String, kind: String = "yaml") -> String, Err

変換した値とErrを返します。変換先の形式で表せない値がある場合は、その値を省略せずにエラーを返します。

引数

名前型省略時の値説明
attrsDictionary省略不可文書の先頭などに付ける、名前と値を持った付加情報。
bodyString省略不可書き込む内容、またはレスポンスに含める本文。
kindString"yaml"メタデータの形式。yaml・toml・json。

戻り値

String, Err

エラー

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

xml

xml(src: String) -> Dictionary, Err
英語原文

Parse markup text into a structured dictionary and report malformed input.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

Dictionary, Err

エラー

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

to_xml

to_xml(data: Dictionary, indent: int = 0) -> String, Err

変換した値とErrを返します。変換先の形式で表せない値がある場合は、その値を省略せずにエラーを返します。

引数

名前型省略時の値説明
dataDictionary省略不可処理するデータ。上に示した引数の型に合わせて渡します。
indentint0字下げ1段あたりの空白数。

戻り値

String, Err

エラー

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

env

env(src: String) -> Dictionary, Err

環境変数の辞書とErrを返します。不正な名前や、閉じていない引用符はエラーになります。

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

Dictionary, Err

エラー

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

to_env

to_env(data: Dictionary) -> String, Err

変換した値とErrを返します。変換先の形式で表せない値がある場合は、その値を省略せずにエラーを返します。

引数

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

戻り値

String, Err

エラー

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

tar

tar(entries: Array) -> PackedByteArray, Err

変換した値とErrを返します。変換先の形式で表せない値がある場合は、その値を省略せずにエラーを返します。

引数

名前型省略時の値説明
entriesArray省略不可名前と内容を持つアーカイブ項目。

戻り値

PackedByteArray, Err

エラー

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

untar

untar(data: PackedByteArray) -> Array, Err
英語原文

Decode an in-memory archive into entries without extracting them onto the filesystem.

引数

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

戻り値

Array, Err

エラー

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

json_encode

json_encode(value: Variant, opts: Dictionary = {  }) -> PackedByteArray, Err

値を厳密なJSONのUTF-8バイト列にします。

引数

名前型省略時の値説明
valueVariant省略不可英語原文 Value to serialize.
optsDictionary{ }英語原文 Encoding options for formatting and validation.

戻り値

PackedByteArray, Err

英語原文

UTF-8 encoded JSON bytes.

エラー

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

英語原文

Unsupported or cyclic values and non-finite numbers return Err.

非有限数、対応していない型、循環参照は、あいまいな値へ変えず失敗にします。

設定はdeterministicとescape_htmlがbool、max_bytesとmax_depthがintです。型が違えばErr.INVALID_DATA、上限を超えればErr.LIMITEDを返します。

json_encode_async()が終わるまで、入力のArrayとDictionary、その子要素を変更しないでください。設定の辞書は開始時に複製されます。

関連文書

json_decode

json_decode(data: PackedByteArray) -> Variant, Err

バイト列を厳密なJSONとして読みます。

引数

名前型省略時の値説明
dataPackedByteArray省略不可英語原文 UTF-8 JSON input bytes.

戻り値

Variant, Err

英語原文

Parsed value; a successful null is distinct from a parse failure.

エラー

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

英語原文

Malformed JSON or invalid input encoding returns Err.

不正なUTF-8と重複した名前は失敗にします。符号付き64ビットに収まる整数はintのまま戻り、小数、指数表記、範囲外の値はfloatになります。文字列とキーの\u0000は保持します。

関連文書

hex_encode

hex_encode(data: PackedByteArray) -> String
英語原文

Encode bytes as hexadecimal text.

引数

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

戻り値

String

エラー

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

hex_decode

hex_decode(text: String) -> PackedByteArray, Err
英語原文

Decode hexadecimal text into bytes.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

PackedByteArray, Err

エラー

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

base64_encode

base64_encode(data: PackedByteArray) -> String
英語原文

Encode bytes as Base64 text.

引数

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

戻り値

String

エラー

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

base64_decode

base64_decode(text: String, raw: bool = false) -> PackedByteArray, Err

Base64の文字列をバイト列に戻します。既定では末尾のパディング(=)付きとして扱い、raw=trueを指定するとパディングなしとして扱います。失敗時も、変換できたバイト列は返します。

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。
rawboolfalseパディングを持たないraw形式としてデコードするかどうか。

戻り値

PackedByteArray, Err

エラー

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

base64url_encode

base64url_encode(data: PackedByteArray) -> String
英語原文

Encode bytes as URL-safe Base64 text.

引数

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

戻り値

String

エラー

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

base64url_decode

base64url_decode(text: String, raw: bool = true) -> PackedByteArray, Err

URL用のBase64文字列をバイト列に戻します。既定はパディングなしのraw=trueです。パディング付きの入力はraw=falseを指定します。暗号署名の解析では、正しい表記かどうかを別途検査します。

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。
rawbooltrueパディングのない表現をデコードするかどうか。

戻り値

PackedByteArray, Err

エラー

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

base32_encode

base32_encode(data: PackedByteArray) -> String
英語原文

Encode bytes as Base32 text.

引数

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

戻り値

String

エラー

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

base32_decode

base32_decode(text: String, raw: bool = false) -> PackedByteArray, Err

Base32の文字列をバイト列に戻します。文字は大文字を使います。既定では末尾のパディング(=)付きとして扱い、raw=trueを指定するとパディングなしとして扱います。失敗時も、変換できたバイト列は返します。

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。
rawboolfalseパディングのない表現をデコードするかどうか。

戻り値

PackedByteArray, Err

エラー

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

varint_encode

varint_encode(n: int) -> PackedByteArray
英語原文

Encode an integer as variable-length bytes.

引数

名前型省略時の値説明
nint省略不可エンコード、または数値操作へ渡す整数。

戻り値

PackedByteArray

エラー

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

varint_decode

varint_decode(data: PackedByteArray, at: int = 0) -> Dictionary, Err
英語原文

Read an integer from variable-length bytes.

引数

名前型省略時の値説明
dataPackedByteArray省略不可処理するデータ。上に示した引数の型に合わせて渡します。
atint0読み取りを始める位置。先頭を0として、バイト数で指定します。

戻り値

Dictionary, Err

エラー

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

concat

concat(parts: Array) -> PackedByteArray
英語原文

Concatenate byte sequences.

引数

名前型省略時の値説明
partsArray省略不可組み立てる名前やパスなどの各部分。上に示した引数の型に合わせて渡します。

戻り値

PackedByteArray

エラー

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

equals

equals(a: PackedByteArray, b: PackedByteArray) -> bool
英語原文

Check whether two byte sequences are equal.

引数

名前型省略時の値説明
aPackedByteArray省略不可1つ目の入力、または比較する値。
bPackedByteArray省略不可2つ目の入力、または比較する値。

戻り値

bool

エラー

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

includes

includes(hay: PackedByteArray, needle: PackedByteArray) -> bool
英語原文

Check whether bytes contain a subsequence.

引数

名前型省略時の値説明
hayPackedByteArray省略不可パターンを検索する対象のバイト列。
needlePackedByteArray省略不可対象のバイト列から探すパターン。

戻り値

bool

エラー

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

index_of

index_of(hay: PackedByteArray, needle: PackedByteArray, from: int = 0) -> int
英語原文

Return the first byte-subsequence position.

引数

名前型省略時の値説明
hayPackedByteArray省略不可パターンを検索する対象のバイト列。
needlePackedByteArray省略不可対象のバイト列から探すパターン。
fromint0操作の開始点。

戻り値

int

エラー

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

last_index_of

last_index_of(hay: PackedByteArray, needle: PackedByteArray) -> int
英語原文

Return the last byte-subsequence position.

引数

名前型省略時の値説明
hayPackedByteArray省略不可パターンを検索する対象のバイト列。
needlePackedByteArray省略不可対象のバイト列から探すパターン。

戻り値

int

エラー

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

starts_with

starts_with(hay: PackedByteArray, prefix: PackedByteArray) -> bool
英語原文

Check whether bytes begin with a prefix.

引数

名前型省略時の値説明
hayPackedByteArray省略不可パターンを検索する対象のバイト列。
prefixPackedByteArray省略不可名前やパスなどの先頭に付ける文字列。

戻り値

bool

エラー

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

ends_with

ends_with(hay: PackedByteArray, suffix: PackedByteArray) -> bool
英語原文

Check whether bytes end with a suffix.

引数

名前型省略時の値説明
hayPackedByteArray省略不可パターンを検索する対象のバイト列。
suffixPackedByteArray省略不可文字列の末尾に一致するか調べたり、取り除いたりする文字列。

戻り値

bool

エラー

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

repeat

repeat(src: PackedByteArray, times: int) -> PackedByteArray
英語原文

Repeat a byte sequence the specified number of times.

引数

名前型省略時の値説明
srcPackedByteArray省略不可読み取る、または変換する入力元。ファイル操作では元のパス。
timesint省略不可入力列を繰り返す回数。

戻り値

PackedByteArray

エラー

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

fit

fit(src: PackedByteArray, size: int) -> PackedByteArray
英語原文

Resize a byte sequence to the specified length.

引数

名前型省略時の値説明
srcPackedByteArray省略不可読み取る、または変換する入力元。ファイル操作では元のパス。
sizeint省略不可要求する出力のバイト数。

戻り値

PackedByteArray

エラー

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

split

split(src: PackedByteArray, sep: PackedByteArray) -> Array
英語原文

Split bytes on a delimiter sequence.

引数

名前型省略時の値説明
srcPackedByteArray省略不可読み取る、または変換する入力元。ファイル操作では元のパス。
sepPackedByteArray省略不可レコードやフィールドの分割・連結に使う区切り。

戻り値

Array

エラー

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

msgpack

msgpack(value: Variant) -> PackedByteArray, Err

変換した値とErrを返します。変換先の形式で表せない値がある場合は、その値を省略せずにエラーを返します。

引数

名前型省略時の値説明
valueVariant省略不可指定したデータ形式へ変換する値。

戻り値

PackedByteArray, Err

エラー

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

unmsgpack

unmsgpack(data: PackedByteArray) -> Variant, Err

MessagePackのデータを読み取ります。不正なUTF-8やNULを含む文字列はPackedByteArrayで保持し、先頭のBOMも残します。

引数

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

戻り値

Variant, Err

エラー

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

cbor

cbor(value: Variant) -> PackedByteArray, Err

変換した値とErrを返します。変換先の形式で表せない値がある場合は、その値を省略せずにエラーを返します。

引数

名前型省略時の値説明
valueVariant省略不可指定したデータ形式へ変換する値。

戻り値

PackedByteArray, Err

エラー

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

uncbor

uncbor(data: PackedByteArray) -> Variant, Err

CBORのデータを読み取ります。不正なUTF-8の文字列はエラーになります。NULを含む正しい文字列は、切り捨てずにPackedByteArrayで保持します。

引数

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

戻り値

Variant, Err

エラー

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

sha224

sha224(msg: PackedByteArray) -> PackedByteArray
英語原文

Compute a SHA-224 digest.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

PackedByteArray

エラー

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

sha256

sha256(msg: PackedByteArray) -> PackedByteArray
英語原文

Compute a SHA-256 digest.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

PackedByteArray

エラー

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

sha384

sha384(msg: PackedByteArray) -> PackedByteArray
英語原文

Compute a SHA-384 digest.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

PackedByteArray

エラー

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

sha512

sha512(msg: PackedByteArray) -> PackedByteArray
英語原文

Compute a SHA-512 digest.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

PackedByteArray

エラー

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

sha3_224

sha3_224(msg: PackedByteArray) -> PackedByteArray
英語原文

Compute a SHA3-224 digest.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

PackedByteArray

エラー

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

sha3_256

sha3_256(msg: PackedByteArray) -> PackedByteArray
英語原文

Compute a SHA3-256 digest.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

PackedByteArray

エラー

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

sha3_384

sha3_384(msg: PackedByteArray) -> PackedByteArray
英語原文

Compute a SHA3-384 digest.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

PackedByteArray

エラー

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

sha3_512

sha3_512(msg: PackedByteArray) -> PackedByteArray
英語原文

Compute a SHA3-512 digest.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

PackedByteArray

エラー

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

sha1

sha1(msg: PackedByteArray) -> PackedByteArray
英語原文

Compute a SHA-1 digest.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

PackedByteArray

エラー

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

hmac

hmac(hash: String, key: PackedByteArray, msg: PackedByteArray) -> PackedByteArray, Err
英語原文

Compute HMAC with the selected hash.

引数

名前型省略時の値説明
hashString省略不可使用するハッシュの計算方式。
keyPackedByteArray省略不可この操作の認証鍵、または疑似ランダム鍵のバイト列。
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

PackedByteArray, Err

エラー

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

hmac_sha256

hmac_sha256(key: PackedByteArray, msg: PackedByteArray) -> PackedByteArray
英語原文

Compute HMAC-SHA-256.

引数

名前型省略時の値説明
keyPackedByteArray省略不可この操作の認証鍵、または疑似ランダム鍵のバイト列。
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

PackedByteArray

エラー

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

xor_bytes

xor_bytes(a: PackedByteArray, b: PackedByteArray) -> PackedByteArray
英語原文

Combine two byte sequences with exclusive OR.

引数

名前型省略時の値説明
aPackedByteArray省略不可1つ目の入力、または比較する値。
bPackedByteArray省略不可2つ目の入力、または比較する値。

戻り値

PackedByteArray

エラー

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

equal_ct

equal_ct(a: PackedByteArray, b: PackedByteArray) -> bool
英語原文

Compare two byte sequences in constant time.

引数

名前型省略時の値説明
aPackedByteArray省略不可1つ目の入力、または比較する値。
bPackedByteArray省略不可2つ目の入力、または比較する値。

戻り値

bool

エラー

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

pbkdf2_sha256

pbkdf2_sha256(password: PackedByteArray, salt: PackedByteArray, rounds: int) -> PackedByteArray, Err

生成した32バイトの鍵とErrを返します。反復回数が1以下の場合は、1回として計算します。

引数

名前型省略時の値説明
passwordPackedByteArray省略不可鍵導出の入力にするパスワードのバイト列。
saltPackedByteArray省略不可鍵導出用のソルトのバイト列。導出済みの鍵を指定する場所ではありません。
roundsint省略不可パスワードからの鍵導出で行う反復回数。

戻り値

PackedByteArray, Err

エラー

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

pbkdf2

pbkdf2(hash: String, password: PackedByteArray, salt: PackedByteArray, rounds: int, size: int) -> PackedByteArray, Err
英語原文

Derive a PBKDF2 key with the selected hash and output length.

引数

名前型省略時の値説明
hashString省略不可使用するハッシュの計算方式。
passwordPackedByteArray省略不可鍵導出の入力にするパスワードのバイト列。
saltPackedByteArray省略不可鍵導出用のソルトのバイト列。導出済みの鍵を指定する場所ではありません。
roundsint省略不可パスワードからの鍵導出で行う反復回数。
sizeint省略不可要求する出力のバイト数。

戻り値

PackedByteArray, Err

エラー

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

hkdf

hkdf(hash: String, secret: PackedByteArray, salt: PackedByteArray, info: PackedByteArray, size: int) -> PackedByteArray, Err
英語原文

Derive an HKDF key from a secret, salt, and context information.

引数

名前型省略時の値説明
hashString省略不可使用するハッシュの計算方式。
secretPackedByteArray省略不可鍵を生成するための元の秘密データ。
saltPackedByteArray省略不可鍵導出用のソルトのバイト列。導出済みの鍵を指定する場所ではありません。
infoPackedByteArray省略不可生成する鍵の用途などを表す、アプリケーション固有のバイト列。
sizeint省略不可要求する出力のバイト数。

戻り値

PackedByteArray, Err

エラー

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

hkdf_extract

hkdf_extract(hash: String, secret: PackedByteArray, salt: PackedByteArray) -> PackedByteArray, Err
英語原文

Extract an HKDF pseudorandom key from a secret and salt.

引数

名前型省略時の値説明
hashString省略不可使用するハッシュの計算方式。
secretPackedByteArray省略不可鍵を生成するための元の秘密データ。
saltPackedByteArray省略不可鍵導出用のソルトのバイト列。導出済みの鍵を指定する場所ではありません。

戻り値

PackedByteArray, Err

エラー

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

hkdf_expand

hkdf_expand(hash: String, key: PackedByteArray, info: PackedByteArray, size: int) -> PackedByteArray, Err
英語原文

Expand an HKDF key from a pseudorandom key and context information.

引数

名前型省略時の値説明
hashString省略不可使用するハッシュの計算方式。
keyPackedByteArray省略不可この操作の認証鍵、または疑似ランダム鍵のバイト列。
infoPackedByteArray省略不可生成する鍵の用途などを表す、アプリケーション固有のバイト列。
sizeint省略不可要求する出力のバイト数。

戻り値

PackedByteArray, Err

エラー

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

pbkdf2_sha256_async

pbkdf2_sha256_async(password: PackedByteArray, salt: PackedByteArray, rounds: int) -> await PackedByteArray, Err
英語原文

Run key derivation on CPU workers.

引数

名前型省略時の値説明
passwordPackedByteArray省略不可鍵導出の入力にするパスワードのバイト列。
saltPackedByteArray省略不可鍵導出用のソルトのバイト列。導出済みの鍵を指定する場所ではありません。
roundsint省略不可パスワードからの鍵導出で行う反復回数。

戻り値

await PackedByteArray, Err

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

エラー

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

pbkdf2_async

pbkdf2_async(hash: String, password: PackedByteArray, salt: PackedByteArray, rounds: int, size: int) -> await PackedByteArray, Err
英語原文

Dispatch PBKDF2 with the selected hash to a CPU worker.

引数

名前型省略時の値説明
hashString省略不可使用するハッシュの計算方式。
passwordPackedByteArray省略不可鍵導出の入力にするパスワードのバイト列。
saltPackedByteArray省略不可鍵導出用のソルトのバイト列。導出済みの鍵を指定する場所ではありません。
roundsint省略不可パスワードからの鍵導出で行う反復回数。
sizeint省略不可要求する出力のバイト数。

戻り値

await PackedByteArray, Err

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

エラー

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

hkdf_async

hkdf_async(hash: String, secret: PackedByteArray, salt: PackedByteArray, info: PackedByteArray, size: int) -> await PackedByteArray, Err
英語原文

Dispatch HKDF key derivation to a CPU worker.

引数

名前型省略時の値説明
hashString省略不可使用するハッシュの計算方式。
secretPackedByteArray省略不可鍵を生成するための元の秘密データ。
saltPackedByteArray省略不可鍵導出用のソルトのバイト列。導出済みの鍵を指定する場所ではありません。
infoPackedByteArray省略不可生成する鍵の用途などを表す、アプリケーション固有のバイト列。
sizeint省略不可要求する出力のバイト数。

戻り値

await PackedByteArray, Err

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

エラー

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

hkdf_extract_async

hkdf_extract_async(hash: String, secret: PackedByteArray, salt: PackedByteArray) -> await PackedByteArray, Err
英語原文

Dispatch HKDF extraction to a CPU worker.

引数

名前型省略時の値説明
hashString省略不可使用するハッシュの計算方式。
secretPackedByteArray省略不可鍵を生成するための元の秘密データ。
saltPackedByteArray省略不可鍵導出用のソルトのバイト列。導出済みの鍵を指定する場所ではありません。

戻り値

await PackedByteArray, Err

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

エラー

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

hkdf_expand_async

hkdf_expand_async(hash: String, key: PackedByteArray, info: PackedByteArray, size: int) -> await PackedByteArray, Err
英語原文

Dispatch HKDF expansion to a CPU worker.

引数

名前型省略時の値説明
hashString省略不可使用するハッシュの計算方式。
keyPackedByteArray省略不可この操作の認証鍵、または疑似ランダム鍵のバイト列。
infoPackedByteArray省略不可生成する鍵の用途などを表す、アプリケーション固有のバイト列。
sizeint省略不可要求する出力のバイト数。

戻り値

await PackedByteArray, Err

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

エラー

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

json_encode_async

json_encode_async(value: Variant, opts: Dictionary = {  }) -> await PackedByteArray, Err

値を厳密なJSONのUTF-8バイト列にします。

引数

名前型省略時の値説明
valueVariant省略不可英語原文 Value to serialize.
optsDictionary{ }英語原文 Encoding options for formatting and validation.

戻り値

await PackedByteArray, Err

英語原文

UTF-8 encoded JSON bytes.

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

エラー

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

英語原文

Unsupported or cyclic values and non-finite numbers return Err.

非有限数、対応していない型、循環参照は、あいまいな値へ変えず失敗にします。

設定はdeterministicとescape_htmlがbool、max_bytesとmax_depthがintです。型が違えばErr.INVALID_DATA、上限を超えればErr.LIMITEDを返します。

json_encode_async()が終わるまで、入力のArrayとDictionary、その子要素を変更しないでください。設定の辞書は開始時に複製されます。

関連文書

json_decode_async

json_decode_async(data: PackedByteArray) -> await Variant, Err

バイト列を厳密なJSONとして読みます。

引数

名前型省略時の値説明
dataPackedByteArray省略不可英語原文 UTF-8 JSON input bytes.

戻り値

await Variant, Err

英語原文

Parsed value; a successful null is distinct from a parse failure.

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

エラー

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

英語原文

Malformed JSON or invalid input encoding returns Err.

不正なUTF-8と重複した名前は失敗にします。符号付き64ビットに収まる整数はintのまま戻り、小数、指数表記、範囲外の値はfloatになります。文字列とキーの\u0000は保持します。

関連文書

msgpack_async

msgpack_async(value: Variant) -> await PackedByteArray, Err
英語原文

Dispatch MessagePack encoding to a CPU worker.

引数

名前型省略時の値説明
valueVariant省略不可指定したデータ形式へ変換する値。

戻り値

await PackedByteArray, Err

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

エラー

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

unmsgpack_async

unmsgpack_async(data: PackedByteArray) -> await Variant, Err
英語原文

Dispatch MessagePack decoding to a CPU worker.

引数

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

戻り値

await Variant, Err

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

エラー

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

cbor_async

cbor_async(value: Variant) -> await PackedByteArray, Err
英語原文

Dispatch CBOR encoding to a CPU worker.

引数

名前型省略時の値説明
valueVariant省略不可指定したデータ形式へ変換する値。

戻り値

await PackedByteArray, Err

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

エラー

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

uncbor_async

uncbor_async(data: PackedByteArray) -> await Variant, Err
英語原文

Dispatch CBOR decoding to a CPU worker.

引数

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

戻り値

await Variant, Err

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

エラー

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

sha224_async

sha224_async(msg: PackedByteArray) -> await PackedByteArray
英語原文

Dispatch SHA-224 hashing to a CPU worker.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

await PackedByteArray

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

エラー

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

sha256_async

sha256_async(msg: PackedByteArray) -> await PackedByteArray
英語原文

Dispatch SHA-256 hashing to a CPU worker.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

await PackedByteArray

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

エラー

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

sha384_async

sha384_async(msg: PackedByteArray) -> await PackedByteArray
英語原文

Dispatch SHA-384 hashing to a CPU worker.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

await PackedByteArray

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

エラー

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

sha512_async

sha512_async(msg: PackedByteArray) -> await PackedByteArray
英語原文

Dispatch SHA-512 hashing to a CPU worker.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

await PackedByteArray

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

エラー

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

sha3_224_async

sha3_224_async(msg: PackedByteArray) -> await PackedByteArray
英語原文

Dispatch SHA3-224 hashing to a CPU worker.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

await PackedByteArray

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

エラー

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

sha3_256_async

sha3_256_async(msg: PackedByteArray) -> await PackedByteArray
英語原文

Dispatch SHA3-256 hashing to a CPU worker.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

await PackedByteArray

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

エラー

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

sha3_384_async

sha3_384_async(msg: PackedByteArray) -> await PackedByteArray
英語原文

Dispatch SHA3-384 hashing to a CPU worker.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

await PackedByteArray

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

エラー

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

sha3_512_async

sha3_512_async(msg: PackedByteArray) -> await PackedByteArray
英語原文

Dispatch SHA3-512 hashing to a CPU worker.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

await PackedByteArray

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

エラー

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

sha1_async

sha1_async(msg: PackedByteArray) -> await PackedByteArray
英語原文

Dispatch SHA-1 hashing to a CPU worker.

引数

名前型省略時の値説明
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

await PackedByteArray

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

エラー

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

hmac_async

hmac_async(hash: String, key: PackedByteArray, msg: PackedByteArray) -> await PackedByteArray, Err
英語原文

Dispatch HMAC with the selected hash to a CPU worker.

引数

名前型省略時の値説明
hashString省略不可使用するハッシュの計算方式。
keyPackedByteArray省略不可この操作の認証鍵、または疑似ランダム鍵のバイト列。
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

await PackedByteArray, Err

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

エラー

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

hmac_sha256_async

hmac_sha256_async(key: PackedByteArray, msg: PackedByteArray) -> await PackedByteArray
英語原文

Dispatch HMAC-SHA-256 to a CPU worker.

引数

名前型省略時の値説明
keyPackedByteArray省略不可この操作の認証鍵、または疑似ランダム鍵のバイト列。
msgPackedByteArray省略不可ハッシュ・認証の対象となるバイト列。

戻り値

await PackedByteArray

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

エラー

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

hex_encode_async

hex_encode_async(data: PackedByteArray) -> await String
英語原文

Dispatch hexadecimal encoding to a CPU worker.

引数

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

戻り値

await String

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

エラー

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

hex_decode_async

hex_decode_async(text: String) -> await PackedByteArray, Err
英語原文

Dispatch hexadecimal decoding to a CPU worker.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

await PackedByteArray, Err

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

エラー

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

base64_encode_async

base64_encode_async(data: PackedByteArray) -> await String
英語原文

Dispatch Base64 encoding to a CPU worker.

引数

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

戻り値

await String

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

エラー

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

base64_decode_async

base64_decode_async(text: String, raw: bool = false) -> await PackedByteArray, Err
英語原文

Dispatch Base64 decoding to a CPU worker.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。
rawboolfalseパディングを持たないraw形式としてデコードするかどうか。

戻り値

await PackedByteArray, Err

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

エラー

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

base64url_encode_async

base64url_encode_async(data: PackedByteArray) -> await String
英語原文

Dispatch URL-safe Base64 encoding to a CPU worker.

引数

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

戻り値

await String

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

エラー

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

base64url_decode_async

base64url_decode_async(text: String, raw: bool = true) -> await PackedByteArray, Err
英語原文

Dispatch URL-safe Base64 decoding to a CPU worker.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。
rawbooltrueパディングのない表現をデコードするかどうか。

戻り値

await PackedByteArray, Err

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

エラー

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

base32_encode_async

base32_encode_async(data: PackedByteArray) -> await String
英語原文

Dispatch Base32 encoding to a CPU worker.

引数

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

戻り値

await String

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

エラー

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

base32_decode_async

base32_decode_async(text: String, raw: bool = false) -> await PackedByteArray, Err
英語原文

Dispatch Base32 decoding to a CPU worker.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。
rawboolfalseパディングのない表現をデコードするかどうか。

戻り値

await PackedByteArray, Err

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

エラー

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

concat_async

concat_async(parts: Array) -> await PackedByteArray
英語原文

Dispatch byte-sequence concatenation to a CPU worker.

引数

名前型省略時の値説明
partsArray省略不可組み立てる名前やパスなどの各部分。上に示した引数の型に合わせて渡します。

戻り値

await PackedByteArray

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

エラー

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

equals_async

equals_async(a: PackedByteArray, b: PackedByteArray) -> await bool
英語原文

Dispatch byte-sequence equality checks to a CPU worker.

引数

名前型省略時の値説明
aPackedByteArray省略不可1つ目の入力、または比較する値。
bPackedByteArray省略不可2つ目の入力、または比較する値。

戻り値

await bool

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

エラー

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

includes_async

includes_async(hay: PackedByteArray, needle: PackedByteArray) -> await bool
英語原文

Dispatch byte-subsequence searches to a CPU worker.

引数

名前型省略時の値説明
hayPackedByteArray省略不可パターンを検索する対象のバイト列。
needlePackedByteArray省略不可対象のバイト列から探すパターン。

戻り値

await bool

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

エラー

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

index_of_async

index_of_async(hay: PackedByteArray, needle: PackedByteArray, from: int = 0) -> await int
英語原文

Dispatch first byte-subsequence searches to a CPU worker.

引数

名前型省略時の値説明
hayPackedByteArray省略不可パターンを検索する対象のバイト列。
needlePackedByteArray省略不可対象のバイト列から探すパターン。
fromint0操作の開始点。

戻り値

await int

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

エラー

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

last_index_of_async

last_index_of_async(hay: PackedByteArray, needle: PackedByteArray) -> await int
英語原文

Dispatch last byte-subsequence searches to a CPU worker.

引数

名前型省略時の値説明
hayPackedByteArray省略不可パターンを検索する対象のバイト列。
needlePackedByteArray省略不可対象のバイト列から探すパターン。

戻り値

await int

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

エラー

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

starts_with_async

starts_with_async(hay: PackedByteArray, prefix: PackedByteArray) -> await bool
英語原文

Dispatch byte-prefix comparison to a CPU worker.

引数

名前型省略時の値説明
hayPackedByteArray省略不可パターンを検索する対象のバイト列。
prefixPackedByteArray省略不可名前やパスなどの先頭に付ける文字列。

戻り値

await bool

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

エラー

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

ends_with_async

ends_with_async(hay: PackedByteArray, suffix: PackedByteArray) -> await bool
英語原文

Dispatch byte-suffix comparison to a CPU worker.

引数

名前型省略時の値説明
hayPackedByteArray省略不可パターンを検索する対象のバイト列。
suffixPackedByteArray省略不可文字列の末尾に一致するか調べたり、取り除いたりする文字列。

戻り値

await bool

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

エラー

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

repeat_async

repeat_async(src: PackedByteArray, times: int) -> await PackedByteArray
英語原文

Dispatch byte repetition to a CPU worker.

引数

名前型省略時の値説明
srcPackedByteArray省略不可読み取る、または変換する入力元。ファイル操作では元のパス。
timesint省略不可入力列を繰り返す回数。

戻り値

await PackedByteArray

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

エラー

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

fit_async

fit_async(src: PackedByteArray, size: int) -> await PackedByteArray
英語原文

Dispatch byte-sequence resizing to a CPU worker.

引数

名前型省略時の値説明
srcPackedByteArray省略不可読み取る、または変換する入力元。ファイル操作では元のパス。
sizeint省略不可要求する出力のバイト数。

戻り値

await PackedByteArray

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

エラー

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

split_async

split_async(src: PackedByteArray, sep: PackedByteArray) -> await Array
英語原文

Dispatch byte-sequence splitting to a CPU worker.

引数

名前型省略時の値説明
srcPackedByteArray省略不可読み取る、または変換する入力元。ファイル操作では元のパス。
sepPackedByteArray省略不可レコードやフィールドの分割・連結に使う区切り。

戻り値

await Array

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

エラー

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

xor_bytes_async

xor_bytes_async(a: PackedByteArray, b: PackedByteArray) -> await PackedByteArray
英語原文

Dispatch bytewise exclusive OR to a CPU worker.

引数

名前型省略時の値説明
aPackedByteArray省略不可1つ目の入力、または比較する値。
bPackedByteArray省略不可2つ目の入力、または比較する値。

戻り値

await PackedByteArray

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

エラー

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

equal_ct_async

equal_ct_async(a: PackedByteArray, b: PackedByteArray) -> await bool
英語原文

Dispatch constant-time comparison to a CPU worker.

引数

名前型省略時の値説明
aPackedByteArray省略不可1つ目の入力、または比較する値。
bPackedByteArray省略不可2つ目の入力、または比較する値。

戻り値

await bool

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

エラー

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

csv_async

csv_async(src: String, sep: String = ",") -> await Array, Err
英語原文

Dispatch in-memory format conversion to CPU workers.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。
sepString","レコードやフィールドの分割・連結に使う区切り。

戻り値

await Array, Err

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

エラー

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

to_csv_async

to_csv_async(rows: Array, sep: String = ",") -> await String
英語原文

Dispatch CSV encoding to a CPU worker.

引数

名前型省略時の値説明
rowsArray省略不可入力順の行。データベースの一括実行では各行が1組のパラメーターです。
sepString","レコードやフィールドの分割・連結に使う区切り。

戻り値

await String

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

エラー

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

csv_objects_async

csv_objects_async(src: String, sep: String = ",") -> await Array, Err
英語原文

Dispatch object CSV parsing to a CPU worker.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。
sepString","レコードやフィールドの分割・連結に使う区切り。

戻り値

await Array, Err

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

エラー

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

to_csv_objects_async

to_csv_objects_async(items: Array, sep: String = ",") -> await String
英語原文

Dispatch object CSV encoding to a CPU worker.

引数

名前型省略時の値説明
itemsArray省略不可変換・収集する入力要素を元の順番で並べたもの。
sepString","レコードやフィールドの分割・連結に使う区切り。

戻り値

await String

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

エラー

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

ini_async

ini_async(src: String) -> await Dictionary, Err
英語原文

Dispatch INI parsing to a CPU worker.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

await Dictionary, Err

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

エラー

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

to_ini_async

to_ini_async(data: Dictionary) -> await String
英語原文

Dispatch INI encoding to a CPU worker.

引数

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

戻り値

await String

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

エラー

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

toml_async

toml_async(src: String) -> await Dictionary, Err
英語原文

Dispatch TOML parsing to a CPU worker.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

await Dictionary, Err

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

エラー

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

to_toml_async

to_toml_async(data: Dictionary, prefix: String = "") -> await String, Err
英語原文

Dispatch TOML encoding to a CPU worker.

引数

名前型省略時の値説明
dataDictionary省略不可処理するデータ。上に示した引数の型に合わせて渡します。
prefixString""エンコードしたテーブルの前に付けるパスの接頭辞。

戻り値

await String, Err

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

エラー

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

yaml_async

yaml_async(src: String) -> await Variant, Err
英語原文

Dispatch YAML parsing to a CPU worker.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

await Variant, Err

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

エラー

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

to_yaml_async

to_yaml_async(data: Variant, depth: int = 0) -> await String, Err
英語原文

Dispatch YAML encoding to a CPU worker.

引数

名前型省略時の値説明
dataVariant省略不可処理するデータ。上に示した引数の型に合わせて渡します。
depthint0データを文字列に変換するときの、入れ子や字下げの開始位置。

戻り値

await String, Err

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

エラー

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

jsonc_async

jsonc_async(src: String) -> await Variant, Err
英語原文

Dispatch commented JSON parsing to a CPU worker.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

await Variant, Err

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

エラー

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

strip_jsonc_async

strip_jsonc_async(src: String) -> await String
英語原文

Dispatch JSON comment stripping to a CPU worker.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

await String

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

エラー

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

jsonl_async

jsonl_async(src: String) -> await Array, Err
英語原文

Dispatch JSON Lines parsing to a CPU worker.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

await Array, Err

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

エラー

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

to_jsonl_async

to_jsonl_async(items: Array) -> await String, Err
英語原文

Dispatch JSON Lines encoding to a CPU worker.

引数

名前型省略時の値説明
itemsArray省略不可変換・収集する入力要素を元の順番で並べたもの。

戻り値

await String, Err

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

エラー

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

front_matter_async

front_matter_async(src: String) -> await Dictionary, Err
英語原文

Dispatch front-matter parsing to a CPU worker.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

await Dictionary, Err

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

エラー

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

to_front_matter_async

to_front_matter_async(attrs: Dictionary, body: String, kind: String = "yaml") -> await String, Err
英語原文

Dispatch front-matter encoding to a CPU worker.

引数

名前型省略時の値説明
attrsDictionary省略不可文書の先頭などに付ける、名前と値を持った付加情報。
bodyString省略不可書き込む内容、またはレスポンスに含める本文。
kindString"yaml"メタデータの形式。yaml・toml・json。

戻り値

await String, Err

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

エラー

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

xml_async

xml_async(src: String) -> await Dictionary, Err
英語原文

Dispatch XML parsing to a CPU worker.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

await Dictionary, Err

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

エラー

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

to_xml_async

to_xml_async(data: Dictionary, indent: int = 0) -> await String, Err
英語原文

Dispatch XML encoding to a CPU worker.

引数

名前型省略時の値説明
dataDictionary省略不可処理するデータ。上に示した引数の型に合わせて渡します。
indentint0字下げ1段あたりの空白数。

戻り値

await String, Err

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

エラー

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

env_async

env_async(src: String) -> await Dictionary, Err
英語原文

Dispatch dotenv parsing to a CPU worker.

引数

名前型省略時の値説明
srcString省略不可読み取る、または変換する入力元。ファイル操作では元のパス。

戻り値

await Dictionary, Err

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

エラー

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

to_env_async

to_env_async(data: Dictionary) -> await String, Err
英語原文

Dispatch dotenv encoding to a CPU worker.

引数

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

戻り値

await String, Err

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

エラー

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

tar_async

tar_async(entries: Array) -> await PackedByteArray, Err
英語原文

Dispatch tar encoding to a CPU worker.

引数

名前型省略時の値説明
entriesArray省略不可名前と内容を持つアーカイブ項目。

戻り値

await PackedByteArray, Err

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

エラー

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

untar_async

untar_async(data: PackedByteArray) -> await Array, Err
英語原文

Dispatch tar decoding to a CPU worker.

引数

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

戻り値

await Array, Err

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

エラー

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