gdドキュメント0.8.0

APIリファレンス

GD.http

HTTPリクエストの送信、URL・クエリ文字列・メディアタイプの組み立てと解析を行います。fetchは呼び出した処理だけを待たせ、fetch_asyncはSignalを返します。

メソッド

fetch

fetch(url: String, opts: Dictionary = {  }) -> GDHTTPResponse, Err

HTTPリクエストを送り、レスポンスを返します。既定のHTTPメソッドはGETです。404や500などのHTTPステータスコードは、サーバーから届いたレスポンスです。通信自体の失敗とは分けて確認してください。

引数

名前型省略時の値説明
urlString省略不可HTTPまたはHTTPSの絶対URL。
optsDictionary{ }method・headers・body・timeoutなどのリクエスト設定。timeoutの単位は秒。

戻り値

GDHTTPResponse, Err

GDHTTPResponseからステータス、ヘッダー、本文を取得できます。

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

エラー

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

接続・TLS・タイムアウト・送信の失敗はErrで返ります。404などのステータスはレスポンス側で確認します。

max_bodyは0..9223372036854775807バイトを受け付け、0は上限なしです。レスポンスヘッダーは10 MiBまでです。

関連文書

fetch_async

fetch_async(url: String, opts: Dictionary = {  }) -> await GDHTTPResponse, Err

HTTPリクエストを送り、レスポンスを返します。既定のHTTPメソッドはGETです。404や500などのHTTPステータスコードは、サーバーから届いたレスポンスです。通信自体の失敗とは分けて確認してください。

引数

名前型省略時の値説明
urlString省略不可HTTPまたはHTTPSの絶対URL。
optsDictionary{ }method・headers・body・timeoutなどのリクエスト設定。timeoutの単位は秒。

戻り値

await GDHTTPResponse, Err

GDHTTPResponseからステータス、ヘッダー、本文を取得できます。

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

エラー

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

接続・TLS・タイムアウト・送信の失敗はErrで返ります。404などのステータスはレスポンス側で確認します。

max_bodyは0..9223372036854775807バイトを受け付け、0は上限なしです。レスポンスヘッダーは10 MiBまでです。

関連文書

parse_url

parse_url(raw: String) -> Dictionary, Err

URLを解析します。raw_queryには元のクエリ文字列、queryには解析できた項目が入ります。クエリ文字列の解析エラーはdecode_queryで確認してください。

引数

名前型省略時の値説明
rawString省略不可解析するURLまたはクエリの文字列。

戻り値

Dictionary, Err

エラー

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

parse_url_async

parse_url_async(raw: String) -> await Dictionary, Err
英語原文

Dispatch URL parsing to a CPU worker.

引数

名前型省略時の値説明
rawString省略不可解析するURLまたはクエリの文字列。

戻り値

await Dictionary, Err

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

エラー

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

build_url

build_url(url: Dictionary) -> String

URLを組み立てます。raw_queryがあれば優先します。queryの内容を変更してURLを作り直す場合は、raw_queryを削除してください。

引数

名前型省略時の値説明
urlDictionary省略不可型に従ったHTTP URL文字列、または解析済みURLの構成要素辞書。

戻り値

String

エラー

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

build_url_async

build_url_async(url: Dictionary) -> await String
英語原文

Dispatch URL formatting to a CPU worker.

引数

名前型省略時の値説明
urlDictionary省略不可型に従ったHTTP URL文字列、または解析済みURLの構成要素辞書。

戻り値

await String

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

エラー

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

request_target

request_target(url: Dictionary) -> String
英語原文

Build an HTTP request target from URL components.

引数

名前型省略時の値説明
urlDictionary省略不可型に従ったHTTP URL文字列、または解析済みURLの構成要素辞書。

戻り値

String

エラー

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

request_target_async

request_target_async(url: Dictionary) -> await String
英語原文

Dispatch request-target construction to a CPU worker.

引数

名前型省略時の値説明
urlDictionary省略不可型に従ったHTTP URL文字列、または解析済みURLの構成要素辞書。

戻り値

await String

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

エラー

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

default_port

default_port(scheme: String) -> int
英語原文

Return a scheme's default port.

引数

名前型省略時の値説明
schemeString省略不可httpやhttpsなどのURLスキーム名。

戻り値

int

エラー

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

decode_query

decode_query(raw: String) -> Dictionary, Err

キーごとの値をすべてArrayに入れた辞書と、最初のErrを返します。読み取れた項目は残します。不正なUTF-8やNULを含むキーと値はPackedByteArrayで保持します。

引数

名前型省略時の値説明
rawString省略不可解析するURLまたはクエリの文字列。

戻り値

Dictionary, Err

エラー

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

素のセミコロンと壊れたpercentエスケープは失敗として返します。

decode_query_async

decode_query_async(raw: String) -> await Dictionary, Err

キーごとの値をすべてArrayに入れた辞書と、最初のErrを返します。読み取れた項目は残します。不正なUTF-8やNULを含むキーと値はPackedByteArrayで保持します。

引数

名前型省略時の値説明
rawString省略不可解析するURLまたはクエリの文字列。

戻り値

await Dictionary, Err

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

エラー

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

素のセミコロンと壊れたpercentエスケープは失敗として返します。

encode_query

encode_query(query: Dictionary) -> String

クエリ文字列を作ります。値がArrayなら同じキーを繰り返し、キーのバイト順に並べます。単一の値とPackedByteArrayにも対応し、空白は+に変換します。

引数

名前型省略時の値説明
queryDictionary省略不可エンコードするクエリパラメーターの名前と値。

戻り値

String

エラー

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

encode_query_async

encode_query_async(query: Dictionary) -> await String
英語原文

Dispatch query encoding to a CPU worker.

引数

名前型省略時の値説明
queryDictionary省略不可エンコードするクエリパラメーターの名前と値。

戻り値

await String

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

エラー

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

media_type

media_type(path: String) -> String
英語原文

Select a media type from a filename.

引数

名前型省略時の値説明
pathString省略不可ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。

戻り値

String

エラー

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

media_type_for_extension

media_type_for_extension(ext: String) -> String
英語原文

Select a media type from an extension.

引数

名前型省略時の値説明
extString省略不可メディア型の検索に使う拡張子。

戻り値

String

エラー

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

is_textual

is_textual(kind: String) -> bool
英語原文

Check whether a media type is textual.

引数

名前型省略時の値説明
kindString省略不可調べるメディア型。指定されたパラメーターも含みます。

戻り値

bool

エラー

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

extension_for_media_type

extension_for_media_type(kind: String) -> String
英語原文

Return the extension corresponding to a media type.

引数

名前型省略時の値説明
kindString省略不可調べるメディア型。指定されたパラメーターも含みます。

戻り値

String

エラー

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