gdドキュメント0.8.0

APIリファレンス

GD.id

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

メソッド

ulid

ulid(ms: int = -1) -> String
英語原文

Create a ULID for the specified time.

引数

名前型省略時の値説明
msint-1メソッドの定義に従った、ミリ秒単位の時刻または時間。

戻り値

String

エラー

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

is_ulid

is_ulid(text: String) -> bool
英語原文

Check whether text is a ULID.

引数

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

戻り値

bool

エラー

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

ulid_time

ulid_time(text: String) -> int, Err
英語原文

Read the timestamp from a ULID.

引数

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

戻り値

int, Err

エラー

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

uuid

uuid() -> String
英語原文

Create a random version-4 UUID.

引数

引数はありません。

戻り値

String

エラー

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

uuid_v5

uuid_v5(space: String, name: String) -> String, Err
英語原文

Create a name-based version-5 UUID.

引数

名前型省略時の値説明
spaceString省略不可指定名と組み合わせるUUIDの名前空間。
nameString省略不可対象を登録・参照するための名前。

戻り値

String, Err

エラー

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

uuid_v5_async

uuid_v5_async(space: String, name: String) -> await String, Err
英語原文

Dispatch UUID generation for long names to a CPU worker.

引数

名前型省略時の値説明
spaceString省略不可指定名と組み合わせるUUIDの名前空間。
nameString省略不可対象を登録・参照するための名前。

戻り値

await String, Err

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

エラー

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

is_uuid

is_uuid(text: String) -> bool
英語原文

Check whether text is a UUID.

引数

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

戻り値

bool

エラー

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

uuid_bytes

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

Convert a UUID to 16 bytes.

引数

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

戻り値

PackedByteArray, Err

エラー

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

uuid_version

uuid_version(text: String) -> int
英語原文

Return a UUID's version.

引数

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

戻り値

int

エラー

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

nil_uuid

nil_uuid() -> String
英語原文

Return the nil UUID.

引数

引数はありません。

戻り値

String

エラー

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

dns_namespace

dns_namespace() -> String
英語原文

Return the DNS UUID namespace.

引数

引数はありません。

戻り値

String

エラー

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

url_namespace

url_namespace() -> String
英語原文

Return the URL UUID namespace.

引数

引数はありません。

戻り値

String

エラー

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

oid_namespace

oid_namespace() -> String
英語原文

Return the OID UUID namespace.

引数

引数はありません。

戻り値

String

エラー

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