APIリファレンス
Err
失敗の種類、説明、追加情報、原因、部分結果を持つ値です。Err.NOT_FOUNDなどは共有値で、直接返せます。独立した失敗はjoin()でまとめ、原因に同じ種類があるかはfind()で調べます。
プロパティ
msg: Stringkind: Err失敗の種類、説明、追加情報、原因、部分結果を持つ値です。Err.NOT_FOUNDなどは共有値で、直接返せます。独立した失敗はjoin()でまとめ、原因に同じ種類があるかはfind()で調べます。
info: Dictionarycause: Err失敗の種類、説明、追加情報、原因、部分結果を持つ値です。Err.NOT_FOUNDなどは共有値で、直接返せます。独立した失敗はjoin()でまとめ、原因に同じ種類があるかはfind()で調べます。
causes: Arraypartial: Variant
定数
ERROR = ErrNOT_FOUND = ErrPERMISSION_DENIED = ErrALREADY_EXISTS = ErrINVALID_DATA = ErrTIMED_OUT = ErrINTERRUPTED = ErrUNSUPPORTED = ErrUNAUTHENTICATED = ErrLIMITED = Err
メソッド
not_found(msg: String = "") -> Errpermission_denied(msg: String = "") -> Erralready_exists(msg: String = "") -> Errinvalid_data(msg: String = "") -> Errtimed_out(msg: String = "") -> Errinterrupted(msg: String = "") -> Errunsupported(msg: String = "") -> Errunauthenticated(msg: String = "") -> Errlimited(msg: String = "") -> Errfrom(reason: Variant, kind: Err = null) -> Errjoin(errors: Array) -> Erras_kind(kind: Err) -> Errnote(msg: String, info: Dictionary = { }) -> Errwith_partial(value: Variant) -> Errfind(target: Variant, where: Dictionary = { }) -> Errtext() -> Stringname_of(kind: Err) -> Stringnames() -> PackedStringArray
not_found
not_found(msg: String = "") -> Err英語原文Report a missing target with optional detail.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | "" | この操作に添えるメッセージ。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
permission_denied
permission_denied(msg: String = "") -> Err英語原文Report rejected access with optional detail.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | "" | この操作に添えるメッセージ。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
already_exists
already_exists(msg: String = "") -> Err英語原文Report a duplicate target with optional detail.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | "" | この操作に添えるメッセージ。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
invalid_data
invalid_data(msg: String = "") -> Err英語原文Report malformed input with optional detail.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | "" | この操作に添えるメッセージ。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
timed_out
timed_out(msg: String = "") -> Err英語原文Report an expired deadline with optional detail.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | "" | この操作に添えるメッセージ。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
interrupted
interrupted(msg: String = "") -> Err英語原文Report interrupted work with optional detail.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | "" | この操作に添えるメッセージ。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
unsupported
unsupported(msg: String = "") -> Err英語原文Report unavailable behavior with optional detail.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | "" | この操作に添えるメッセージ。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
unauthenticated
unauthenticated(msg: String = "") -> Err英語原文Report failed authentication with optional detail.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | "" | この操作に添えるメッセージ。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
limited
limited(msg: String = "") -> Err英語原文Report exhausted capacity with optional detail.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | "" | この操作に添えるメッセージ。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
from
from(reason: Variant, kind: Err = null) -> Err英語原文Convert a reason while retaining the selected shared category.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
reason | Variant | 省略不可 | 結果に保持する失敗理由。 |
kind | Err | null | 分類・照合に使うエラー種別。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
join
join(errors: Array) -> Err英語原文Combine two independent native failures without building a script array.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
errors | Array | 省略不可 | まとめて保持する独立したErr値。nullは除きます。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
as_kind
as_kind(kind: Err) -> Err英語原文Reclassify an error with a shared category value.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
kind | Err | 省略不可 | 分類・照合に使うエラー種別。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
note
note(msg: String, info: Dictionary = { }) -> Err元のエラーを原因に残し、説明と省略可能なinfo項目を持つ新しいエラー値を作ります。同じ名前の項目は新しい値だけで上書きします。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | 省略不可 | この操作に添えるメッセージ。 |
info | Dictionary | { } | エラーの判定や詳しい説明に使う追加情報。 |
戻り値
Err
元のエラーを原因に持つ新しいErr。
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
使用例
return Err.NOT_FOUND.note("商品を取得", {"code": "E_0008"})関連文書
with_partial
with_partial(value: Variant) -> Err英語原文Attach completed work to a new error without changing the original.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
value | Variant | 省略不可 | 保存、変換、検査など、この関数で処理する値。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
find
find(target: Variant, where: Dictionary = { }) -> Errこのエラーと原因を順に探します。Errを渡すと共有の種類または個別値を照合し、辞書を渡すと同じエラー値のinfo項目を照合します。各項目の値は型も一致する必要があります。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
target | Variant | 省略不可 | 共有の種類、個別のErr値、または照合するinfo項目を入れた空でない辞書。 |
where | Dictionary | { } | targetと同じErr値で照合する追加のinfo項目。 |
戻り値
Err
最初に一致したErr値。一致しない場合や空の検索辞書ではnull。
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
使用例
var conflict := e.find({"source": "postgres", "code": "40001"})
var missing := e.find(Err.NOT_FOUND, {"code": "E_0008"})関連文書
text
text() -> String英語原文Return a one-line description including causes.
引数
引数はありません。
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
name_of
name_of(kind: Err) -> String英語原文Spell the category represented by a shared error value.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
kind | Err | 省略不可 | 分類・照合に使うエラー種別。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
names
names() -> PackedStringArray英語原文List the category attributes exposed by the error class.
引数
引数はありません。
戻り値
PackedStringArray
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。