gdドキュメント0.8.0

APIリファレンス

GDCLIFlags

コマンドラインのオプションを型に合わせて読み取り、オプション以外の引数も集めます。真偽値はtrue/falseや1/0、整数は0x・0o・0bで始まる表記も使えます。

メソッド

set_name

set_name(name: String) -> void
英語原文

---------------- Command-line flags ----------------

引数

名前型省略時の値説明
nameString省略不可対象を登録・参照するための名前。

戻り値

void

値を返しません。

エラー

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

flag_bool

flag_bool(name: String, fallback: bool, help: String = "") -> void
英語原文

Declare a boolean command-line flag.

引数

名前型省略時の値説明
nameString省略不可対象を登録・参照するための名前。
fallbackbool省略不可対象の値が存在しないか省略された場合に使う値。
helpString""コマンドの使用法に表示する説明。

戻り値

void

値を返しません。

エラー

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

flag_str

flag_str(name: String, fallback: String, help: String = "") -> void
英語原文

Declare a string command-line flag.

引数

名前型省略時の値説明
nameString省略不可対象を登録・参照するための名前。
fallbackString省略不可対象の値が存在しないか省略された場合に使う値。
helpString""コマンドの使用法に表示する説明。

戻り値

void

値を返しません。

エラー

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

flag_int

flag_int(name: String, fallback: int, help: String = "") -> void
英語原文

Declare an integer command-line flag.

引数

名前型省略時の値説明
nameString省略不可対象を登録・参照するための名前。
fallbackint省略不可対象の値が存在しないか省略された場合に使う値。
helpString""コマンドの使用法に表示する説明。

戻り値

void

値を返しません。

エラー

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

parse

parse(args: Array) -> Variant, Err
英語原文

Accept both --name=value and --name value.

引数

名前型省略時の値説明
argsArray省略不可関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。

戻り値

Variant, Err

エラー

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

get_bool

get_bool(name: String) -> bool
英語原文

Return a boolean flag's current value.

引数

名前型省略時の値説明
nameString省略不可対象を登録・参照するための名前。

戻り値

bool

エラー

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

get_str

get_str(name: String) -> String
英語原文

Return a string flag's current value.

引数

名前型省略時の値説明
nameString省略不可対象を登録・参照するための名前。

戻り値

String

エラー

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

get_int

get_int(name: String) -> int
英語原文

Return an integer flag's current value.

引数

名前型省略時の値説明
nameString省略不可対象を登録・参照するための名前。

戻り値

int

エラー

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

get_rest

get_rest() -> PackedStringArray
英語原文

Return positional arguments left after parsing registered flags.

引数

引数はありません。

戻り値

PackedStringArray

エラー

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

usage

usage() -> String
英語原文

Return usage guidance.

引数

引数はありません。

戻り値

String

エラー

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