APIリファレンス
GD.file
ファイルの読み書き、パスの操作、各種データ形式の読み取りを行います。ファイル全体を扱う場合も少しずつ読み書きする場合も、呼び出した処理だけが完了を待ちます。_async付きの関数はSignalを返します。
res://は起動時の作業ディレクトリです。最初に実行するスクリプトが子ディレクトリにあっても変わりません。そこより上へ遡る相対パスは、どちらの実行方式でも拒否します。--strictでは、起動ディレクトリ内の絶対パスはres://と同じ読み取り専用の検査を通り、親や兄弟のディレクトリは拒否します。リンクを使っても外へは出られません。-Aを付けてもファイルの範囲は広がりません。
--mountと絶対パスはLinuxとmacOS用です。Windowsでは拒否します。
マウント名に使えるのは小文字の英数字と-です。次の名前は予約済みで使えません: res、user、uid、pipe、local、libgodot、tcp、unix、http、https、file、data、cache。
メソッド
open(path: String, mode: String = "read") -> GDFileStream, Erropen_async(path: String, mode: String = "read") -> await GDFileStream, Errread_text(path: String) -> String, Errread_bytes(path: String, offset: int = 0, max: int = 0) -> PackedByteArray, Errwrite_text(path: String, body: String) -> Variant, Errreplace_text(path: String, old: Variant, body: String) -> Variant, Errwrite_bytes(path: String, body: PackedByteArray) -> Variant, Errappend_bytes(path: String, body: PackedByteArray) -> Variant, Errappend_text(path: String, body: String) -> Variant, Errexists(path: String) -> boolremove(path: String) -> Variant, Errsize_of(path: String) -> int, Errcopy(src: String, dst: String) -> Variant, Errrename(src: String, dst: String) -> Variant, Errlist_dir(path: String) -> Array, Errmake_dir(path: String) -> Variant, Errensure_dir(path: String) -> Variant, Errwalk(path: String, want_dirs: bool = false, hidden: bool = false) -> Array, Errglob(path: String, pattern: String, hidden: bool = false) -> Array, Errremove_all(path: String) -> Variant, Errcan_read(path: String) -> boolparse_path(path: String) -> Dictionaryformat_path(parts: Dictionary) -> Stringjoin(parts: PackedStringArray) -> Stringdirname(path: String) -> Stringbasename(path: String, suffix: String = "") -> Stringextname(path: String) -> Stringis_absolute(path: String) -> boolnormalize(path: String) -> Stringrelative(from: String, to: String) -> Stringunder(dir: String, name: String) -> Stringcreate_tar(root: String) -> PackedByteArray, Errextract_tar(data: PackedByteArray, root: String) -> int, Errread_csv(path: String, sep: String = ",") -> Array, Errread_ini(path: String) -> Dictionary, Errread_toml(path: String) -> Dictionary, Errread_yaml(path: String) -> Variant, Errread_jsonc(path: String) -> Variant, Errread_jsonl(path: String) -> Array, Errread_front_matter(path: String) -> Dictionary, Errread_xml(path: String) -> Dictionary, Errread_env(path: String = ".env") -> Dictionary, Errread_tar(path: String) -> Array, Errread_csv_async(path: String, sep: String = ",") -> await Array, Errread_ini_async(path: String) -> await Dictionary, Errread_toml_async(path: String) -> await Dictionary, Errread_yaml_async(path: String) -> await Variant, Errread_jsonc_async(path: String) -> await Variant, Errread_jsonl_async(path: String) -> await Array, Errread_front_matter_async(path: String) -> await Dictionary, Errread_xml_async(path: String) -> await Dictionary, Errread_env_async(path: String = ".env") -> await Dictionary, Errread_tar_async(path: String) -> await Array, Errread_text_async(path: String) -> await String, Errread_bytes_async(path: String, offset: int = 0, max: int = 0) -> await PackedByteArray, Errwrite_text_async(path: String, body: String) -> await Variant, Errwrite_bytes_async(path: String, body: PackedByteArray) -> await Variant, Errappend_text_async(path: String, body: String) -> await Variant, Errappend_bytes_async(path: String, body: PackedByteArray) -> await Variant, Errcopy_async(src: String, dst: String) -> await Variant, Errreplace_text_async(path: String, old: Variant, body: String) -> await Variant, Errexists_async(path: String) -> await boolremove_async(path: String) -> await Variant, Errsize_of_async(path: String) -> await int, Errrename_async(src: String, dst: String) -> await Variant, Errlist_dir_async(path: String) -> await Array, Errmake_dir_async(path: String) -> await Variant, Errensure_dir_async(path: String) -> await Variant, Errwalk_async(path: String, want_dirs: bool = false, hidden: bool = false) -> await Array, Errglob_async(path: String, pattern: String, hidden: bool = false) -> await Array, Errremove_all_async(path: String) -> await Variant, Errcan_read_async(path: String) -> await boolcreate_tar_async(root: String) -> await PackedByteArray, Errextract_tar_async(data: PackedByteArray, root: String) -> await int, Err
open
open(path: String, mode: String = "read") -> GDFileStream, Err入力や出力を分割して処理するためのファイルストリームを開きます。返されたストリームを保持し、使用後に閉じてください。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 開くファイル。 |
mode | String | "read" | read・write・append・read_write。既定のreadは既存ファイルを読み取り用に開きます。 |
戻り値
GDFileStream, Err
ファイルストリーム。
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
オープンや権限検査が失敗する場合があります。ストリームを使う前にErrを確認します。
関連文書
open_async
open_async(path: String, mode: String = "read") -> await GDFileStream, Err入力や出力を分割して処理するためのファイルストリームを開きます。返されたストリームを保持し、使用後に閉じてください。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 開くファイル。 |
mode | String | "read" | read・write・append・read_write。既定のreadは既存ファイルを読み取り用に開きます。 |
戻り値
await GDFileStream, Err
ファイルストリーム。
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
オープンや権限検査が失敗する場合があります。ストリームを使う前にErrを確認します。
関連文書
read_text
read_text(path: String) -> String, Errファイル全体をUTF-8の文字列として読み取ります。ファイルは自動で開閉されます。読み取りを待つ間も、ほかの処理は進みます。文字列に変換せずバイト列のまま扱う場合はread_bytesを使います。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 実行ディレクトリからの相対パス、または明示的にマウントしたパス。 |
戻り値
String, Err
改行を含むファイルの内容。
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ファイルが存在しない場合や、アクセス権限がない場合、読み取りに失敗した場合はErrを返します。空のファイルを読むと、成功しても空文字列になります。成功したかどうかはErrがnullかどうかで判断してください。
使用例
func main():
var text, err = GD.file.read_text("message.txt")
if err != null:
printerr(err)
return 1
print(text)
return 0関連文書
read_bytes
read_bytes(path: String, offset: int = 0, max: int = 0) -> PackedByteArray, Err開始位置と読み取り量を指定して、ファイルをバイト列として読みます。読み取り後はファイルを閉じます。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 読み取るファイル。 |
offset | int | 0 | 0から数えるバイト位置。 |
max | int | 0 | 読み取る最大バイト数。0は残り全体。 |
戻り値
PackedByteArray, Err
読み込んだバイト列を格納するPackedByteArray。
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ファイルの場所やアクセス権限に問題がある場合、読み取りに失敗した場合はErrを返します。
関連文書
write_text
write_text(path: String, body: String) -> Variant, Errファイル内容をUTF-8文字列で上書きします。ファイルの開閉はこの呼び出しが行います。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 書き込み先ファイル。 |
body | String | 省略不可 | 書き込む内容。 |
戻り値
Variant, Err
Errがnullなら書き込みに成功しています。書き込んだバイト数は返しません。
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ファイルの作成や書き込みに失敗した場合、アクセス権限がない場合はErrを返します。親ディレクトリは自動で作成しません。
関連文書
replace_text
replace_text(path: String, old: Variant, body: String) -> Variant, Err英語原文Replace a file asynchronously only if its contents remain unchanged.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
old | Variant | 省略不可 | 条件付き置換で照合する、変更前の想定内容。 |
body | String | 省略不可 | 書き込む内容、またはレスポンスに含める本文。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
write_bytes
write_bytes(path: String, body: PackedByteArray) -> Variant, Errファイル内容をバイト列で上書きします。ファイルの開閉はこの呼び出しが行います。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 書き込み先ファイル。 |
body | PackedByteArray | 省略不可 | 書き込む内容。 |
戻り値
Variant, Err
Errがnullなら書き込みに成功しています。書き込んだバイト数は返しません。
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ファイルの作成や書き込みに失敗した場合、アクセス権限がない場合はErrを返します。親ディレクトリは自動で作成しません。
関連文書
append_bytes
append_bytes(path: String, body: PackedByteArray) -> Variant, Errファイル末尾にバイト列を追記します。ファイルの開閉はこの呼び出しが行います。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 書き込み先ファイル。 |
body | PackedByteArray | 省略不可 | 書き込む内容。 |
戻り値
Variant, Err
Errがnullなら書き込みに成功しています。書き込んだバイト数は返しません。
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ファイルの作成や書き込みに失敗した場合、アクセス権限がない場合はErrを返します。親ディレクトリは自動で作成しません。
関連文書
append_text
append_text(path: String, body: String) -> Variant, Errファイル末尾にUTF-8文字列を追記します。ファイルの開閉はこの呼び出しが行います。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 書き込み先ファイル。 |
body | String | 省略不可 | 書き込む内容。 |
戻り値
Variant, Err
Errがnullなら書き込みに成功しています。書き込んだバイト数は返しません。
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ファイルの作成や書き込みに失敗した場合、アクセス権限がない場合はErrを返します。親ディレクトリは自動で作成しません。
関連文書
exists
exists(path: String) -> bool英語原文Check path existence asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
bool
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
remove
remove(path: String) -> Variant, Err英語原文Remove a file or empty directory asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
size_of
size_of(path: String) -> int, Err英語原文Get a file's byte count asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
int, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
copy
copy(src: String, dst: String) -> Variant, Err英語原文Copy a file to another path asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
src | String | 省略不可 | 読み取る、または変換する入力元。ファイル操作では元のパス。 |
dst | String | 省略不可 | 書き込み先のファイルシステム上のパス。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
rename
rename(src: String, dst: String) -> Variant, Err英語原文Rename a file or directory asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
src | String | 省略不可 | 読み取る、または変換する入力元。ファイル操作では元のパス。 |
dst | String | 省略不可 | 書き込み先のファイルシステム上のパス。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
list_dir
list_dir(path: String) -> Array, Err英語原文List immediate directory entries asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Array, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
make_dir
make_dir(path: String) -> Variant, Err英語原文Create one directory asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ensure_dir
ensure_dir(path: String) -> Variant, Err英語原文Create a directory and missing parents asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
walk
walk(path: String, want_dirs: bool = false, hidden: bool = false) -> Array, Err英語原文Enumerate a directory tree asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
want_dirs | bool | false | 探索結果にディレクトリの項目も含めるかどうか。 |
hidden | bool | false | 照合・探索の対象に隠し項目も含めるかどうか。 |
戻り値
Array, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
glob
glob(path: String, pattern: String, hidden: bool = false) -> Array, Err英語原文Find paths matching a pattern asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
pattern | String | 省略不可 | 指定ディレクトリ内のファイル名に適用するglobパターン。 |
hidden | bool | false | 照合・探索の対象に隠し項目も含めるかどうか。 |
戻り値
Array, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
remove_all
remove_all(path: String) -> Variant, Err英語原文Remove a directory tree and its contents asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
can_read
can_read(path: String) -> bool英語原文Check path readability asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
bool
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
parse_path
parse_path(path: String) -> Dictionary英語原文Parse a path into a component dictionary.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
format_path
format_path(parts: Dictionary) -> String英語原文Format path components as text.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
parts | Dictionary | 省略不可 | 組み立てる名前やパスなどの各部分。上に示した引数の型に合わせて渡します。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
join
join(parts: PackedStringArray) -> String英語原文Join path segments with separators.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
parts | PackedStringArray | 省略不可 | 組み立てる名前やパスなどの各部分。上に示した引数の型に合わせて渡します。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
dirname
dirname(path: String) -> String英語原文Return the parent directory of a path.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
basename
basename(path: String, suffix: String = "") -> String英語原文Return the final path component with the specified suffix removed.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
suffix | String | "" | 文字列の末尾に一致するか調べたり、取り除いたりする文字列。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
extname
extname(path: String) -> String英語原文Return a path's extension.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
is_absolute
is_absolute(path: String) -> bool英語原文Check whether a path is absolute.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
normalize
normalize(path: String) -> String英語原文Normalize redundant separators and parent/current-directory segments.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
relative
relative(from: String, to: String) -> String英語原文Return the relative route between two paths.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
from | String | 省略不可 | 相対パスを求める基準となるパス。 |
to | String | 省略不可 | 基準からの相対パスで表す対象パス。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
under
under(dir: String, name: String) -> String英語原文Resolve a name safely within a directory.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
dir | String | 省略不可 | 操作の基点となるディレクトリ。 |
name | String | 省略不可 | 対象を登録・参照するための名前。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
create_tar
create_tar(root: String) -> PackedByteArray, Err英語原文Archive a directory tree as tar asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
root | String | 省略不可 | アーカイブの作成・展開の基点となるディレクトリ。 |
戻り値
PackedByteArray, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
extract_tar
extract_tar(data: PackedByteArray, root: String) -> int, Err英語原文Extract a tar archive into a directory asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
data | PackedByteArray | 省略不可 | 処理するデータ。上に示した引数の型に合わせて渡します。 |
root | String | 省略不可 | アーカイブの作成・展開の基点となるディレクトリ。 |
戻り値
int, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_csv
read_csv(path: String, sep: String = ",") -> Array, Err英語原文Read document files asynchronously and parse them on workers.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
sep | String | "," | レコードやフィールドの分割・連結に使う区切り。 |
戻り値
Array, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_ini
read_ini(path: String) -> Dictionary, Err英語原文Read an INI file on a worker and parse its dictionary.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_toml
read_toml(path: String) -> Dictionary, Err英語原文Read a TOML file on a worker and parse its dictionary.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_yaml
read_yaml(path: String) -> Variant, Err英語原文Read a YAML file on a worker and parse its value.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_jsonc
read_jsonc(path: String) -> Variant, Err英語原文Read a commented JSON file on a worker and parse its value.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_jsonl
read_jsonl(path: String) -> Array, Err英語原文Read a JSON Lines file on a worker and parse its values.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Array, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_front_matter
read_front_matter(path: String) -> Dictionary, Err英語原文Read a front-matter file on a worker and parse its attributes and body.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_xml
read_xml(path: String) -> Dictionary, Err英語原文Read an XML file on a worker and parse its dictionary.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_env
read_env(path: String = ".env") -> Dictionary, Err英語原文Read a dotenv file on a worker and parse its environment dictionary.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | ".env" | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_tar
read_tar(path: String) -> Array, Err英語原文Read a tar file on a worker and decode its entries.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
Array, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_csv_async
read_csv_async(path: String, sep: String = ",") -> await Array, Err英語原文Read document files asynchronously and parse them on workers.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
sep | String | "," | レコードやフィールドの分割・連結に使う区切り。 |
戻り値
await Array, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_ini_async
read_ini_async(path: String) -> await Dictionary, Err英語原文Read an INI file on a worker and parse its dictionary.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_toml_async
read_toml_async(path: String) -> await Dictionary, Err英語原文Read a TOML file on a worker and parse its dictionary.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_yaml_async
read_yaml_async(path: String) -> await Variant, Err英語原文Read a YAML file on a worker and parse its value.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_jsonc_async
read_jsonc_async(path: String) -> await Variant, Err英語原文Read a commented JSON file on a worker and parse its value.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_jsonl_async
read_jsonl_async(path: String) -> await Array, Err英語原文Read a JSON Lines file on a worker and parse its values.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Array, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_front_matter_async
read_front_matter_async(path: String) -> await Dictionary, Err英語原文Read a front-matter file on a worker and parse its attributes and body.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_xml_async
read_xml_async(path: String) -> await Dictionary, Err英語原文Read an XML file on a worker and parse its dictionary.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_env_async
read_env_async(path: String = ".env") -> await Dictionary, Err英語原文Read a dotenv file on a worker and parse its environment dictionary.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | ".env" | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_tar_async
read_tar_async(path: String) -> await Array, Err英語原文Read a tar file on a worker and decode its entries.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Array, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
read_text_async
read_text_async(path: String) -> await String, Errファイル全体をUTF-8の文字列として読み取ります。ファイルは自動で開閉されます。読み取りを待つ間も、ほかの処理は進みます。文字列に変換せずバイト列のまま扱う場合はread_bytesを使います。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 実行ディレクトリからの相対パス、または明示的にマウントしたパス。 |
戻り値
await String, Err
改行を含むファイルの内容。
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ファイルが存在しない場合や、アクセス権限がない場合、読み取りに失敗した場合はErrを返します。空のファイルを読むと、成功しても空文字列になります。成功したかどうかはErrがnullかどうかで判断してください。
使用例
func main():
var text, err = GD.file.read_text("message.txt")
if err != null:
printerr(err)
return 1
print(text)
return 0関連文書
read_bytes_async
read_bytes_async(path: String, offset: int = 0, max: int = 0) -> await PackedByteArray, Err開始位置と読み取り量を指定して、ファイルをバイト列として読みます。読み取り後はファイルを閉じます。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 読み取るファイル。 |
offset | int | 0 | 0から数えるバイト位置。 |
max | int | 0 | 読み取る最大バイト数。0は残り全体。 |
戻り値
await PackedByteArray, Err
読み込んだバイト列を格納するPackedByteArray。
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ファイルの場所やアクセス権限に問題がある場合、読み取りに失敗した場合はErrを返します。
関連文書
write_text_async
write_text_async(path: String, body: String) -> await Variant, Errファイル内容をUTF-8文字列で上書きします。ファイルの開閉はこの呼び出しが行います。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 書き込み先ファイル。 |
body | String | 省略不可 | 書き込む内容。 |
戻り値
await Variant, Err
Errがnullなら書き込みに成功しています。書き込んだバイト数は返しません。
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ファイルの作成や書き込みに失敗した場合、アクセス権限がない場合はErrを返します。親ディレクトリは自動で作成しません。
関連文書
write_bytes_async
write_bytes_async(path: String, body: PackedByteArray) -> await Variant, Errファイル内容をバイト列で上書きします。ファイルの開閉はこの呼び出しが行います。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 書き込み先ファイル。 |
body | PackedByteArray | 省略不可 | 書き込む内容。 |
戻り値
await Variant, Err
Errがnullなら書き込みに成功しています。書き込んだバイト数は返しません。
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ファイルの作成や書き込みに失敗した場合、アクセス権限がない場合はErrを返します。親ディレクトリは自動で作成しません。
関連文書
append_text_async
append_text_async(path: String, body: String) -> await Variant, Errファイル末尾にUTF-8文字列を追記します。ファイルの開閉はこの呼び出しが行います。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 書き込み先ファイル。 |
body | String | 省略不可 | 書き込む内容。 |
戻り値
await Variant, Err
Errがnullなら書き込みに成功しています。書き込んだバイト数は返しません。
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ファイルの作成や書き込みに失敗した場合、アクセス権限がない場合はErrを返します。親ディレクトリは自動で作成しません。
関連文書
append_bytes_async
append_bytes_async(path: String, body: PackedByteArray) -> await Variant, Errファイル末尾にバイト列を追記します。ファイルの開閉はこの呼び出しが行います。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | 書き込み先ファイル。 |
body | PackedByteArray | 省略不可 | 書き込む内容。 |
戻り値
await Variant, Err
Errがnullなら書き込みに成功しています。書き込んだバイト数は返しません。
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ファイルの作成や書き込みに失敗した場合、アクセス権限がない場合はErrを返します。親ディレクトリは自動で作成しません。
関連文書
copy_async
copy_async(src: String, dst: String) -> await Variant, Err英語原文Copy a file to another path asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
src | String | 省略不可 | 読み取る、または変換する入力元。ファイル操作では元のパス。 |
dst | String | 省略不可 | 書き込み先のファイルシステム上のパス。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
replace_text_async
replace_text_async(path: String, old: Variant, body: String) -> await Variant, Err英語原文Replace a file asynchronously only if its contents remain unchanged.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
old | Variant | 省略不可 | 条件付き置換で照合する、変更前の想定内容。 |
body | String | 省略不可 | 書き込む内容、またはレスポンスに含める本文。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
exists_async
exists_async(path: String) -> await bool英語原文Check path existence asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await bool
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
remove_async
remove_async(path: String) -> await Variant, Err英語原文Remove a file or empty directory asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
size_of_async
size_of_async(path: String) -> await int, Err英語原文Get a file's byte count asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await int, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
rename_async
rename_async(src: String, dst: String) -> await Variant, Err英語原文Rename a file or directory asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
src | String | 省略不可 | 読み取る、または変換する入力元。ファイル操作では元のパス。 |
dst | String | 省略不可 | 書き込み先のファイルシステム上のパス。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
list_dir_async
list_dir_async(path: String) -> await Array, Err英語原文List immediate directory entries asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Array, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
make_dir_async
make_dir_async(path: String) -> await Variant, Err英語原文Create one directory asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
ensure_dir_async
ensure_dir_async(path: String) -> await Variant, Err英語原文Create a directory and missing parents asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
walk_async
walk_async(path: String, want_dirs: bool = false, hidden: bool = false) -> await Array, Err英語原文Enumerate a directory tree asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
want_dirs | bool | false | 探索結果にディレクトリの項目も含めるかどうか。 |
hidden | bool | false | 照合・探索の対象に隠し項目も含めるかどうか。 |
戻り値
await Array, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
glob_async
glob_async(path: String, pattern: String, hidden: bool = false) -> await Array, Err英語原文Find paths matching a pattern asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
pattern | String | 省略不可 | 指定ディレクトリ内のファイル名に適用するglobパターン。 |
hidden | bool | false | 照合・探索の対象に隠し項目も含めるかどうか。 |
戻り値
await Array, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
remove_all_async
remove_all_async(path: String) -> await Variant, Err英語原文Remove a directory tree and its contents asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
can_read_async
can_read_async(path: String) -> await bool英語原文Check path readability asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
path | String | 省略不可 | ファイルシステム上のパス。相対パスは実行ディレクトリ基準で、アクセス権限の設定に従います。 |
戻り値
await bool
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
create_tar_async
create_tar_async(root: String) -> await PackedByteArray, Err英語原文Archive a directory tree as tar asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
root | String | 省略不可 | アーカイブの作成・展開の基点となるディレクトリ。 |
戻り値
await PackedByteArray, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
extract_tar_async
extract_tar_async(data: PackedByteArray, root: String) -> await int, Err英語原文Extract a tar archive into a directory asynchronously.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
data | PackedByteArray | 省略不可 | 処理するデータ。上に示した引数の型に合わせて渡します。 |
root | String | 省略不可 | アーカイブの作成・展開の基点となるディレクトリ。 |
戻り値
await int, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。