APIリファレンス
GD.id
UUIDと、時刻順に並べられるULIDを生成・検査します。ULID時刻の-1は現在時刻を選び、その他の48ビット範囲外は空文字を返します。範囲外の符号化文字列は拒否します。
メソッド
ulid(ms: int = -1) -> Stringis_ulid(text: String) -> boolulid_time(text: String) -> int, Erruuid() -> Stringuuid_v5(space: String, name: String) -> String, Erruuid_v5_async(space: String, name: String) -> await String, Erris_uuid(text: String) -> booluuid_bytes(text: String) -> PackedByteArray, Erruuid_version(text: String) -> intnil_uuid() -> Stringdns_namespace() -> Stringurl_namespace() -> Stringoid_namespace() -> String
ulid
ulid(ms: int = -1) -> String英語原文Create a ULID for the specified time.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
ms | int | -1 | メソッドの定義に従った、ミリ秒単位の時刻または時間。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
is_ulid
is_ulid(text: String) -> bool英語原文Check whether text is a ULID.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
ulid_time
ulid_time(text: String) -> int, Err英語原文Read the timestamp from a ULID.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
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.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
space | String | 省略不可 | 指定名と組み合わせるUUIDの名前空間。 |
name | String | 省略不可 | 対象を登録・参照するための名前。 |
戻り値
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.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
space | String | 省略不可 | 指定名と組み合わせるUUIDの名前空間。 |
name | String | 省略不可 | 対象を登録・参照するための名前。 |
戻り値
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.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
uuid_bytes
uuid_bytes(text: String) -> PackedByteArray, Err英語原文Convert a UUID to 16 bytes.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
PackedByteArray, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
uuid_version
uuid_version(text: String) -> int英語原文Return a UUID's version.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
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を返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。