gdドキュメント0.8.0

APIリファレンス

GD

ファイル、データ変換、非同期処理、日時など、コマンドラインのプログラムで使う標準機能をまとめています。

プロパティ

async : GD.async

非同期処理を開始したり、複数の処理の完了を待ったり、タイムアウトやキャンセルを扱ったりします。最初に完了した処理の結果を受け取ることもできます。spawnは関数をメインスレッド上で開始します。大きなデータの計算には、各標準モジュールの_async付き関数を使います。

log : GD.log

重要度、時刻、出力先を指定してログを記録します。1行ずつ順番に書き込み、各呼び出しは完了を待って値とErrを返します。flushで、それまでの出力が終わるのを待てます。

net : GD.net

TCP・TLSの接続、接続の待ち受け、UDP通信、名前解決、アドレスの検査を行います。TLSでは既定で証明書チェーンと接続先のホスト名を検証します。完了を待つのは、呼び出した処理だけです。

mail : GD.mail

メールアドレス、日付、ヘッダーを解析し、SMTPサーバーへメールを送ります。STARTTLSは既存接続を暗号化し、失敗時は平文へ戻りません。MIMEの機能はGD.mail.mimeにあります。

http : GD.http

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

web : GD.web

WebサイトやWeb APIを作るための機能です。URLと処理の対応付け、静的ファイル配信、HTMLテンプレート、セッション、CSRF対策、JWT認証、リクエスト数の制限、入力検査を利用できます。

file : GD.file

ファイルの読み書き、パスの操作、各種データ形式の読み取りを行います。ファイル全体を扱う場合も少しずつ読み書きする場合も、呼び出した処理だけが完了を待ちます。_async付きの関数はSignalを返します。

collection : GD.collection

配列や辞書の変換、ヒープ、キュー、キャッシュを扱います。時間のかかる処理は別スレッド、またはほかの処理と交代しながら進めます。Callableを使う操作も、SceneTreeのフレームを待たずにほかのタスクへ実行を譲ります。

data : GD.data

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

id : GD.id

UUIDと、時刻順に並べられるULIDを生成・検査します。ULID時刻の-1は現在時刻を選び、その他の48ビット範囲外は空文字を返します。範囲外の符号化文字列は拒否します。

text : GD.text

文字列の整形と比較を行います。

html : GD.html

HTMLの文字参照、タグ、テンプレートを扱います。テンプレートへ埋め込む値は、本文、属性、URL、スタイル、スクリプトのどこに使うかに応じてエスケープします。

math : GD.math

数学関数、IEEE 754の特殊な値、浮動小数点数とビット列の変換を扱います。

version : GD.version

セマンティックバージョンを解析・比較し、指定したバージョン範囲に含まれるか調べます。

time : GD.time

Unix時刻、ISO 8601、HTTPの日付を変換・計算します。parse_isoはRFC 3339形式を受け取ります。加算や差分が64ビット整数の範囲を超える場合は、最大値または最小値になります。

cli : GD.cli

gdのバージョンや文書の表示、コマンドライン引数、環境変数、システム情報の取得に使います。アクセス権限の設定に従います。

test : GD.test

期待した結果と実際の結果を比較する、テスト用の機能です。

database : GD.database

SQLiteとPostgreSQLを共通のAPIで扱います。処理の完了を待つ間も、ほかのGDScriptは動き続けます。_async付きの関数はSignalを返し、あとからawaitで結果を受け取れます。

online : GD.online

オンラインゲームのマッチング先を管理します。ゲームの同期とゲスト認証はgd-godotのOnlineとSecretで行います。

メソッド