APIリファレンス
GD.cli
gdのバージョンや文書の表示、コマンドライン引数、環境変数、システム情報の取得に使います。アクセス権限の設定に従います。
メソッド
version() -> Stringdocs_url() -> Stringflags() -> GDCLIFlagsenv(name: String, fallback: Variant = null) -> Variantrequire_env(name: String) -> String, Errcwd() -> Stringplatform() -> Stringarch() -> Stringstdin_tty() -> boolstdout_tty() -> boolstderr_tty() -> boolpaint(text: String, code: int) -> Stringred(text: String) -> Stringgreen(text: String) -> Stringyellow(text: String) -> Stringblue(text: String) -> Stringgray(text: String) -> Stringbold(text: String) -> Stringrun(path: String, args: PackedStringArray = [], opts: Dictionary = { }) -> Dictionary, Errrun_async(path: String, args: PackedStringArray = [], opts: Dictionary = { }) -> await Dictionary, Err
version
version() -> String英語原文Return the running executable's version.
引数
引数はありません。
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
docs_url
docs_url() -> String英語原文Return the upstream documentation base used to resolve version-independent links.
引数
引数はありません。
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
flags
flags() -> GDCLIFlags英語原文Create a command-line flag parser.
引数
引数はありません。
戻り値
GDCLIFlags
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
env
env(name: String, fallback: Variant = null) -> Variant英語原文Return a permitted environment value or its default.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
name | String | 省略不可 | 対象を登録・参照するための名前。 |
fallback | Variant | null | 対象の値が存在しないか省略された場合に使う値。 |
戻り値
Variant
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
require_env
require_env(name: String) -> String, Err英語原文Return a required environment value or Err.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
name | String | 省略不可 | 対象を登録・参照するための名前。 |
戻り値
String, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
cwd
cwd() -> String英語原文Return the current working directory.
引数
引数はありません。
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
platform
platform() -> String英語原文Return the operating-system name only when permitted.
引数
引数はありません。
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
arch
arch() -> String英語原文Return the CPU architecture name only when permitted.
引数
引数はありません。
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
stdin_tty
stdin_tty() -> bool英語原文Check whether standard input is an interactive terminal.
引数
引数はありません。
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
stdout_tty
stdout_tty() -> bool英語原文Check whether standard output is an interactive terminal.
引数
引数はありません。
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
stderr_tty
stderr_tty() -> bool英語原文Check whether standard error is an interactive terminal.
引数
引数はありません。
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
paint
paint(text: String, code: int) -> String英語原文Decorate terminal text using an ANSI code.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
code | int | 省略不可 | 色出力が有効な場合に適用する端末のSGR装飾コード。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
red
red(text: String) -> String英語原文Decorate terminal text in red.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
green
green(text: String) -> String英語原文Decorate terminal text in green.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
yellow
yellow(text: String) -> String英語原文Decorate terminal text in yellow.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
blue
blue(text: String) -> String英語原文Decorate terminal text in blue.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
gray
gray(text: String) -> String英語原文Decorate terminal text in gray.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
bold
bold(text: String) -> String英語原文Decorate terminal text in bold.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
run
run(path: String, args: PackedStringArray = [], opts: Dictionary = { }) -> Dictionary, Err終了コードと取得済みの出力を返します。終了コードが0以外の場合はErrも返し、info.codeに終了コードを記録します。タイムアウトやキャンセルでも、結果のcodeとoutputは残ります。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
args | PackedStringArray | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
run_async
run_async(path: String, args: PackedStringArray = [], opts: Dictionary = { }) -> await Dictionary, Err英語原文Start a child process and return an awaitable completion signal.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
args | PackedStringArray | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。