APIリファレンス
GD.log
重要度、時刻、出力先を指定してログを記録します。1行ずつ順番に書き込み、各呼び出しは完了を待って値とErrを返します。flushで、それまでの出力が終わるのを待てます。
メソッド
setup(name: String = "", level: String = "info") -> voidset_file(path: String) -> voidset_time(on: bool) -> voidset_color(on: bool) -> voidwrite(level: String, msg: String, extra: Variant = null) -> Variant, Errdebug(msg: String, extra: Variant = null) -> Variant, Errinfo(msg: String, extra: Variant = null) -> Variant, Errwarn(msg: String, extra: Variant = null) -> Variant, Errerror(msg: String, extra: Variant = null) -> Variant, Errresult(error: Err, msg: String) -> Variant, Errwrite_async(level: String, msg: String, extra: Variant = null) -> await Variant, Errdebug_async(msg: String, extra: Variant = null) -> await Variant, Errinfo_async(msg: String, extra: Variant = null) -> await Variant, Errwarn_async(msg: String, extra: Variant = null) -> await Variant, Errerror_async(msg: String, extra: Variant = null) -> await Variant, Errresult_async(error: Err, msg: String) -> await Variant, Errformat(level: String, msg: String, extra: Variant = null) -> Stringflush() -> Variant, Errflush_async() -> await Variant, Err
setup
setup(name: String = "", level: String = "info") -> void英語原文Set the logger name and minimum level.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
name | String | "" | 対象を登録・参照するための名前。 |
level | String | "info" | 最小のログ重要度、または今回使う重要度の名前。 |
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
set_file
set_file(path: String) -> void英語原文Set the file receiving appended log lines.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
set_time
set_time(on: bool) -> void英語原文Configure whether log lines include a timestamp.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
on | bool | 省略不可 | trueで設定を有効にし、falseで無効にします。 |
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
set_color
set_color(on: bool) -> void英語原文Configure terminal color output.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
on | bool | 省略不可 | trueで設定を有効にし、falseで無効にします。 |
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
write
write(level: String, msg: String, extra: Variant = null) -> Variant, Err英語原文Write a line at a level selected by name.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
level | String | 省略不可 | 最小のログ重要度、または今回使う重要度の名前。 |
msg | String | 省略不可 | この操作に添えるメッセージ。 |
extra | Variant | null | ログメッセージと一緒に記録する追加の構造化データ。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
debug
debug(msg: String, extra: Variant = null) -> Variant, Err英語原文Write a debug-level line.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | 省略不可 | この操作に添えるメッセージ。 |
extra | Variant | null | ログメッセージと一緒に記録する追加の構造化データ。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
info
info(msg: String, extra: Variant = null) -> Variant, Err英語原文Write an info-level line.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | 省略不可 | この操作に添えるメッセージ。 |
extra | Variant | null | ログメッセージと一緒に記録する追加の構造化データ。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
warn
warn(msg: String, extra: Variant = null) -> Variant, Err英語原文Write a warning-level line.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | 省略不可 | この操作に添えるメッセージ。 |
extra | Variant | null | ログメッセージと一緒に記録する追加の構造化データ。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
error
error(msg: String, extra: Variant = null) -> Variant, Err英語原文Write an error-level line.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | 省略不可 | この操作に添えるメッセージ。 |
extra | Variant | null | ログメッセージと一緒に記録する追加の構造化データ。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
result
result(error: Err, msg: String) -> Variant, Err英語原文Log a failed operation's error.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
error | Err | 省略不可 | HTTPステータスの選択時に分類するエラー値。 |
msg | String | 省略不可 | この操作に添えるメッセージ。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
write_async
write_async(level: String, msg: String, extra: Variant = null) -> await Variant, Err英語原文Write a line at a level selected by name.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
level | String | 省略不可 | 最小のログ重要度、または今回使う重要度の名前。 |
msg | String | 省略不可 | この操作に添えるメッセージ。 |
extra | Variant | null | ログメッセージと一緒に記録する追加の構造化データ。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
debug_async
debug_async(msg: String, extra: Variant = null) -> await Variant, Err英語原文Write a debug-level line.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | 省略不可 | この操作に添えるメッセージ。 |
extra | Variant | null | ログメッセージと一緒に記録する追加の構造化データ。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
info_async
info_async(msg: String, extra: Variant = null) -> await Variant, Err英語原文Write an info-level line.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | 省略不可 | この操作に添えるメッセージ。 |
extra | Variant | null | ログメッセージと一緒に記録する追加の構造化データ。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
warn_async
warn_async(msg: String, extra: Variant = null) -> await Variant, Err英語原文Write a warning-level line.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | 省略不可 | この操作に添えるメッセージ。 |
extra | Variant | null | ログメッセージと一緒に記録する追加の構造化データ。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
error_async
error_async(msg: String, extra: Variant = null) -> await Variant, Err英語原文Write an error-level line.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
msg | String | 省略不可 | この操作に添えるメッセージ。 |
extra | Variant | null | ログメッセージと一緒に記録する追加の構造化データ。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
result_async
result_async(error: Err, msg: String) -> await Variant, Err英語原文Log a failed operation's error.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
error | Err | 省略不可 | HTTPステータスの選択時に分類するエラー値。 |
msg | String | 省略不可 | この操作に添えるメッセージ。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
format
format(level: String, msg: String, extra: Variant = null) -> String英語原文Format a log line without writing it.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
level | String | 省略不可 | 最小のログ重要度、または今回使う重要度の名前。 |
msg | String | 省略不可 | この操作に添えるメッセージ。 |
extra | Variant | null | ログメッセージと一緒に記録する追加の構造化データ。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
flush
flush() -> Variant, Err英語原文Return a signal after preceding file output completes.
引数
引数はありません。
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
flush_async
flush_async() -> await Variant, Err英語原文Return a signal after preceding file output completes.
引数
引数はありません。
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。