このページの英語版を見る

std.file

ファイルを操作し、ディレクトリをスキャンするためのユーティリティ。関数" を使用する。このモジュールの関数は、ファイルを単位として扱う。を一度に読み書きする。ファイルを開き、ハンドルで操作するにはモジュールを参照のこと。 std.stdio.


カテゴリー	関数
一般的な機能	exists isDir isFile isSymlink rename thisExePath
ディレクトリ	chdir dirEntries getcwd mkdir mkdirRecurse rmdir rmdirRecurse tempDir
ファイル	append copy read readText remove slurp write
シンボリックリンク	symlink readLink
属性	attrIsDir attrIsFile attrIsSymlink getAttributes getLinkAttributes getSize setAttributes
タイムスタンプ	getTimes getTimesWin setTimes timeLastModified timeLastAccessed timeStatusChanged
その他	DirEntry FileException PreserveAttributes SpanMode getAvailableDiskSpace

See Also:

公式チュートリアルモジュール std.stdioでファイルを開き、ハンドルで操作する、モジュール std.pathパス文字列を操作する

License:

Boost License 1.0.

Authors:

Walter Bright, Andrei Alexandrescu, Jonathan M Davis

ソース std/file.d

class FileException: object.Exception;

ファイルI/Oエラーの際にスローされる例外。

Examples:

import std.exception : assertThrown;

assertThrown!FileException("non.existing.file.".readText);

immutable uint errno;

OSのエラーコード。

pure @safe this(scope const(char)[] name, scope const(char)[] msg, string file = __FILE__, size_t line = __LINE__);

エラーメッセージを受け取るコンストラクタ。

Parameters:

const(char)[] `name`	エラーが発生したファイル名。
const(char)[] `msg`	エラーを説明するメッセージ。
string `file`	エラーが発生したファイル。
size_t `line`	エラーが発生した行

@trusted this(scope const(char)[] name, uint errno = .errno, string file = __FILE__, size_t line = __LINE__);

エラー番号を取るコンストラクタ(WindowsではGetLastError WindowsではGetLastError、POSIXではerrno)。

Parameters:

const(char)[] `name`	エラーが発生したファイル名。
uint `errno`	エラー番号。
string `file`	エラーが発生したファイル。デフォルトは__FILE__ 。
size_t `line`	エラーが発生した行。デフォルトは__LINE__ 。

void[] read(R)(R name, size_t upTo = size_t.max) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); void[] read(R)(auto ref R name, size_t upTo = size_t.max) if (isConvertibleToString!R);

ファイル nameの内容全体を読み込み、それを型付きでない配列として返す。ファイル・サイズが upToより大きい場合は upTo バイトだけが読み込まれる。

Parameters:

R `name`	ファイル名を表す文字列または文字の範囲
size_t `upTo`	存在する場合、読み込む最大バイト数

Returns:

読み込むバイト数の型付きでない配列。

Throws:

FileExceptionエラーになる。

See Also:

std.file.readTextテキストファイルの読み込みと検証を行う。

Examples:

import std.utf : byChar;
scope(exit)
{
    assert(exists(deleteme));
    remove(deleteme);
}

std.file.write(deleteme, "1234"); // deleteemeは一時ファイルの名前である
writeln(read(deleteme, 2)); // "12"
writeln(read(deleteme.byChar)); // "1234"
writeln((cast(const(ubyte)[])read(deleteme)).length); // 4

S readText(S = string, R)(auto ref R name) if (isSomeString!S && (isSomeFiniteCharInputRange!R || is(StringTypeOf!R)));

テキストファイルを読み込んで検証する。 std.utf.validateを使って)テキストファイルを読み込む。Sはは任意の文字型の配列である。ただし、幅変換やエンディアン変換は行われない。は行われない。したがって、もし与えられたファイルの文字の幅やエンディアンがSの要素型の幅やエンディアンと異なる場合、検証は失敗する。のバリデーションは失敗する。

Parameters:

S	ファイルの文字列型
R `name`	ファイル名を表す文字列または文字の範囲

Returns:

読み込んだ文字の配列。

Throws:

FileExceptionファイルの読み込みにエラーがある場合 std.utf.UTFExceptionUTFデコードエラーの場合

See Also:

std.file.readバイナリファイルを読み込む。

Examples:

UTF-8テキストでファイルを読み込む。

write(deleteme, "abc"); // deleteemeは一時ファイルの名前である
scope(exit) remove(deleteme);
string content = readText(deleteme);
writeln(content); // "abc"

void write(R)(R name, const void[] buffer) if ((isSomeFiniteCharInputRange!R || isSomeString!R) && !isConvertibleToString!R); void write(R)(auto ref R name, const void[] buffer) if (isConvertibleToString!R);

書き込む bufferファイルに書き込む name.

ファイルがまだ存在しなければ、ファイルを作成する。

Parameters:

R `name`	ファイル名を表す文字列または文字の範囲
void[] `buffer`	ファイルに書き込むデータ

Throws:

FileExceptionに書き込む。

See Also:

std.stdio.toFile

Examples:

scope(exit)
{
    assert(exists(deleteme));
    remove(deleteme);
}

int[] a = [ 0, 1, 1, 2, 3, 5, 8 ];
write(deleteme, a); // deleteemeは一時ファイルの名前である
const bytes = read(deleteme);
const fileInts = () @trusted { return cast(int[]) bytes; }();
writeln(fileInts); // a

void append(R)(R name, const void[] buffer) if ((isSomeFiniteCharInputRange!R || isSomeString!R) && !isConvertibleToString!R); void append(R)(auto ref R name, const void[] buffer) if (isConvertibleToString!R);

ファイルに追加する bufferファイルに追加する name.

ファイルがまだ存在しない場合は作成する。

Parameters:

R `name`	ファイル名を表す文字列または文字の範囲
void[] `buffer`	ファイルに追加するデータ

Throws:

FileExceptionに追加される。

Examples:

scope(exit)
{
    assert(exists(deleteme));
    remove(deleteme);
}

int[] a = [ 0, 1, 1, 2, 3, 5, 8 ];
write(deleteme, a); // deleteemeは一時ファイルの名前である
int[] b = [ 13, 21 ];
append(deleteme, b);
const bytes = read(deleteme);
const fileInts = () @trusted { return cast(int[]) bytes; }();
writeln(fileInts); // a ~ b

void rename(RF, RT)(RF from, RT to) if ((isSomeFiniteCharInputRange!RF || isSomeString!RF) && !isConvertibleToString!RF && (isSomeFiniteCharInputRange!RT || isSomeString!RT) && !isConvertibleToString!RT); void rename(RF, RT)(auto ref RF from, auto ref RT to) if (isConvertibleToString!RF || isConvertibleToString!RT);

ファイル名を変更する fromに変更する。 to必要に応じてディレクトリ間を移動する。ターゲット・ファイルが存在する場合は上書きされる。

異なるマウントポイントやドライブ間でファイル名を変更することはできない。またはドライブ間でファイル名を変更することはできない。POSIXでは、操作はアトミックである。つまり to がすでに存在する場合、操作中にここで toが存在しない時間帯が存在しないことを意味する。参照を参照のこと。のマニュアルを参照のこと。

Parameters:

RF `from`	既存のファイル名を表す文字列または文字の範囲
RT `to`	目的のファイル名を表す文字列または文字の範囲

Throws:

FileExceptionエラー時

Examples:

auto t1 = deleteme, t2 = deleteme~"2";
scope(exit) foreach (t; [t1, t2]) if (t.exists) t.remove();

t1.write("1");
t1.rename(t2);
writeln(t2.readText); // "1"

t1.write("2");
t1.rename(t2);
writeln(t2.readText); // "2"

void remove(R)(R name) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); void remove(R)(auto ref R name) if (isConvertibleToString!R);

ファイルを削除する name.

Parameters:

R name ファイル名を表す文字列または文字の範囲

Throws:

FileExceptionエラー時に

Examples:

import std.exception : assertThrown;

deleteme.write("Hello");
writeln(deleteme.readText); // "Hello"

deleteme.remove;
assertThrown!FileException(deleteme.readText);

ulong getSize(R)(R name) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); ulong getSize(R)(auto ref R name) if (isConvertibleToString!R);

ファイルのサイズを取得する nameをバイト単位で取得する。

Parameters:

R name ファイル名を表す文字列または文字の範囲

Returns:

バイト単位のファイルサイズ。

Throws:

FileExceptionエラー時(ファイルが見つからないなど)。

Examples:

scope(exit) deleteme.remove;

// サイズ1のファイルを作成する
write(deleteme, "a");
writeln(getSize(deleteme)); // 1

// サイズ3のファイルを作成する
write(deleteme, "abc");
writeln(getSize(deleteme)); // 3

void getTimes(R)(R name, out SysTime accessTime, out SysTime modificationTime) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); void getTimes(R)(auto ref R name, out SysTime accessTime, out SysTime modificationTime) if (isConvertibleToString!R);

ファイルやフォルダのアクセス時刻と更新時刻を取得する name.

Parameters:

R `name`	時間を取得するファイル/フォルダ名
SysTime `accessTime`	ファイル/フォルダーが最後にアクセスされた時刻。
SysTime `modificationTime`	ファイル/フォルダーが最後に変更された時間。

Throws:

FileExceptionエラー時

Examples:

import std.datetime : abs, SysTime;

scope(exit) deleteme.remove;
write(deleteme, "a");

SysTime accessTime, modificationTime;

getTimes(deleteme, accessTime, modificationTime);

import std.datetime : Clock, seconds;
auto currTime = Clock.currTime();
enum leeway = 5.seconds;

auto diffAccess = accessTime - currTime;
auto diffModification = modificationTime - currTime;
assert(abs(diffAccess) <= leeway);
assert(abs(diffModification) <= leeway);

void getTimesWin(R)(R name, out SysTime fileCreationTime, out SysTime fileAccessTime, out SysTime fileModificationTime) if (isSomeFiniteCharInputRange!R || isConvertibleToString!R);

この関数はWindows専用である。

ファイルの作成/アクセス/変更時刻を取得する。 name.

これは、getTimes と同じだが、ファイルの作成時刻も取得できる。の作成時刻も得ることができる点を除けば、これはと同じである。

Parameters:

R `name`	時間を取得するファイル名
SysTime `fileCreationTime`	ファイルの作成時刻
SysTime `fileAccessTime`	ファイルが最後にアクセスされた時刻
SysTime `fileModificationTime`	ファイルが最後に変更された時刻

Throws:

FileExceptionエラー時

void setTimes(R)(R name, SysTime accessTime, SysTime modificationTime) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); void setTimes(R)(auto ref R name, SysTime accessTime, SysTime modificationTime) if (isConvertibleToString!R);

ファイルやフォルダーのアクセス/変更時刻を設定する name.

Parameters:

R `name`	時間を取得するファイル/フォルダ名
SysTime `accessTime`	ファイル/フォルダーが最後にアクセスされた時刻。
SysTime `modificationTime`	ファイル/フォルダーが最後に変更された時間。

Throws:

FileExceptionエラー時

Examples:

import std.datetime : DateTime, hnsecs, SysTime;

scope(exit) deleteme.remove;
write(deleteme, "a");

SysTime accessTime = SysTime(DateTime(2010, 10, 4, 0, 0, 30));
SysTime modificationTime = SysTime(DateTime(2018, 10, 4, 0, 0, 30));
setTimes(deleteme, accessTime, modificationTime);

SysTime accessTimeResolved, modificationTimeResolved;
getTimes(deleteme, accessTimeResolved, modificationTimeResolved);

writeln(accessTime); // accessTimeResolved
writeln(modificationTime); // modificationTimeResolved

SysTime timeLastModified(R)(R name) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); SysTime timeLastModified(R)(auto ref R name) if (isConvertibleToString!R);

指定したファイルが最後に更新された時刻を返す。

Parameters:

R name チェックするファイル名

Returns:

A std.datetime.systime.SysTime.

Throws:

FileException指定されたファイルが存在しない場合

Examples:

import std.datetime : abs, DateTime, hnsecs, SysTime;
scope(exit) deleteme.remove;

import std.datetime : Clock, seconds;
auto currTime = Clock.currTime();
enum leeway = 5.seconds;
deleteme.write("bb");
assert(abs(deleteme.timeLastModified - currTime) <= leeway);

SysTime timeLastModified(R)(R name, SysTime returnIfMissing) if (isSomeFiniteCharInputRange!R);

与えられたファイルが最後に更新された時刻を返す。もしファイルが存在しない場合は returnIfMissing.

のようなビルド自動化ツールでよく使われる。やantのようなビルド自動化ツールでよく使われる。ファイル target をファイルsource からリビルドしなければならないかどうか(すなわち、target がファイルより古いか、存在しないか)を調べるには、比較を使用する。がsource より古いか、存在しない)。を使う。このコードは以下をスローする。 FileExceptionsource をスローする。を投げる(当然である)。一方、SysTime.min のデフォルトは存在しないtarget が限りなく古く見えるので、テストは正しくビルドを促す。は正しくビルドを促す。

Parameters:

R `name`	更新時刻を取得するファイル名。
SysTime `returnIfMissing`	与えられたファイルが存在しない場合に返す時間。

Returns:

A std.datetime.systime.SysTime.

例:

if (source.timeLastModified >= target.timeLastModified(SysTime.min))
{
    // (再)構築しなければならない
}
else
{
    // ターゲットは最新である
}

Examples:

import std.datetime : SysTime;

writeln("file.does.not.exist".timeLastModified(SysTime.min)); // SysTime.min

auto source = deleteme ~ "source";
auto target = deleteme ~ "target";
scope(exit) source.remove, target.remove;

source.write(".");
assert(target.timeLastModified(SysTime.min) < source.timeLastModified);
target.write(".");
assert(target.timeLastModified(SysTime.min) >= source.timeLastModified);

pure nothrow SysTime timeLastModified()(auto ref stat_t statbuf);

この関数はPOSIX専用である。

与えられたファイルが最後に更新された時刻を返す。

Parameters:

stat_t statbuf stat_tはファイルから取得される。

pure nothrow SysTime timeLastAccessed()(auto ref stat_t statbuf);

この関数は POSIX-Only である。

与えられたファイルが最後にアクセスされた時刻を返す。

Parameters:

stat_t statbuf stat_tはファイルから取得される。

pure nothrow SysTime timeStatusChanged()(auto ref stat_t statbuf);

この関数はPOSIX専用である。

与えられたファイルが最後に変更された時刻を返す。

Parameters:

stat_t statbuf stat_tはファイルから取得される。

bool exists(R)(R name) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); bool exists(R)(auto ref R name) if (isConvertibleToString!R);

与えられたファイル(またはディレクトリ)が存在するかどうかを判定する。

Parameters:

R name ファイル名を表す文字列または文字の範囲

Returns:

入力として指定されたファイル名が存在すれば真

Examples:

auto f = deleteme ~ "does.not.exist";
assert(!f.exists);

f.write("hello");
assert(f.exists);

f.remove;
assert(!f.exists);

uint getAttributes(R)(R name) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); uint getAttributes(R)(auto ref R name) if (isConvertibleToString!R);

与えられたファイルの属性を返す。

WindowsとPOSIXシステムのファイル属性は全く異なることに注意。が返すものである。Windowsでは、これらの属性はで返される値であるのに対し、POSIXシステムでは st_mode を呼び出すことで得られるstat struct の一部である。を呼び出すことで得られる値の一部である。 stat 関数を呼び出すことで得られる値の一部である。

POSIXシステムでは、指定されたファイルがシンボリックリンクの場合、attributesはシンボリックリンクが指すファイルの属性となる。属性は、シンボリックリンクが指すファイルの属性である。リンクが指すファイルの属性である。

Parameters:

R name 属性を取得するファイル。

Returns:

ファイルの属性をuint 。

Throws:

FileExceptionエラーになる。

Examples:

ファイルを指定して属性を取得する

import std.exception : assertThrown;

auto f = deleteme ~ "file";
scope(exit) f.remove;

assert(!f.exists);
assertThrown!FileException(f.getAttributes);

f.write(".");
auto attributes = f.getAttributes;
assert(!attributes.attrIsDir);
assert(attributes.attrIsFile);

Examples:

ディレクトリを指定して属性を取得する

import std.exception : assertThrown;

auto dir = deleteme ~ "dir";
scope(exit) dir.rmdir;

assert(!dir.exists);
assertThrown!FileException(dir.getAttributes);

dir.mkdir;
auto attributes = dir.getAttributes;
assert(attributes.attrIsDir);
assert(!attributes.attrIsFile);

uint getLinkAttributes(R)(R name) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); uint getLinkAttributes(R)(auto ref R name) if (isConvertibleToString!R);

指定されたファイルがシンボリックリンクである場合、そのファイルを指すのではなく、シンボリックリンク自体の属性を返す。の属性を返す。与えられたファイルがシンボリックリンクでない場合、この関数はgetAttributesと同じ結果を返す。と同じ結果を返す。

Windowsでは、getLinkAttributesはgetAttributesと同じである。Windowsでは、getLinkAttributesはgetAttributesと同じである。シンボリックリンクを扱うときに、Windows用に特別なコードを書く必要がないようにするためである。シンボリックリンクを扱うときに、Windows用に特別なコードを書く必要がない。

Parameters:

R name シンボリックリンクの属性を取得するファイル。

Returns:

属性

Throws:

FileExceptionエラーになる。

Examples:

import std.exception : assertThrown;

auto source = deleteme ~ "source";
auto target = deleteme ~ "target";

assert(!source.exists);
assertThrown!FileException(source.getLinkAttributes);

// Windowsではシンボリックリンクが使えない
version (Posix)
{
    scope(exit) source.remove, target.remove;

    target.write("target");
    target.symlink(source);
    writeln(source.readText); // "target"
    assert(source.isSymlink);
    assert(source.getLinkAttributes.attrIsSymlink);
}

Examples:

ファイルがシンボリックリンクでない場合、getLinkAttributesはgetAttributesと同じように動作する。

import std.exception : assertThrown;

auto f = deleteme ~ "file";
scope(exit) f.remove;

assert(!f.exists);
assertThrown!FileException(f.getLinkAttributes);

f.write(".");
auto attributes = f.getLinkAttributes;
assert(!attributes.attrIsDir);
assert(attributes.attrIsFile);

Examples:

ファイルがシンボリックリンクでない場合、getLinkAttributesはgetAttributesと同じように動作する。

import std.exception : assertThrown;

auto dir = deleteme ~ "dir";
scope(exit) dir.rmdir;

assert(!dir.exists);
assertThrown!FileException(dir.getLinkAttributes);

dir.mkdir;
auto attributes = dir.getLinkAttributes;
assert(attributes.attrIsDir);
assert(!attributes.attrIsFile);

void setAttributes(R)(R name, uint attributes) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); void setAttributes(R)(auto ref R name, uint attributes) if (isConvertibleToString!R);

与えられたファイルの属性を設定する。

例えば、プログラム的にはUnixの chmod +x name に相当するプログラムは name.setAttributes(name.getAttributes | octal!700).

Parameters:

R `name`	ファイル名
uint `attributes`	ファイルを設定する属性

Throws:

FileException指定されたファイルが存在しない場合

Examples:

ファイルを指定して属性を設定する

import std.exception : assertThrown;
import std.conv : octal;

auto f = deleteme ~ "file";
version (Posix)
{
    scope(exit) f.remove;

    assert(!f.exists);
    assertThrown!FileException(f.setAttributes(octal!777));

    f.write(".");
    auto attributes = f.getAttributes;
    assert(!attributes.attrIsDir);
    assert(attributes.attrIsFile);

    f.setAttributes(octal!777);
    attributes = f.getAttributes;

    writeln((attributes & 1023)); // octal!777
}

Examples:

ディレクトリを指定して属性を設定する

import std.exception : assertThrown;
import std.conv : octal;

auto dir = deleteme ~ "dir";
version (Posix)
{
    scope(exit) dir.rmdir;

    assert(!dir.exists);
    assertThrown!FileException(dir.setAttributes(octal!777));

    dir.mkdir;
    auto attributes = dir.getAttributes;
    assert(attributes.attrIsDir);
    assert(!attributes.attrIsFile);

    dir.setAttributes(octal!777);
    attributes = dir.getAttributes;

    writeln((attributes & 1023)); // octal!777
}

@property bool isDir(R)(R name) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); @property bool isDir(R)(auto ref R name) if (isConvertibleToString!R);

指定されたファイルがディレクトリであるかどうかを返す。

Parameters:

R name ファイルへのパス。

Returns:

nameがディレクトリを指定した場合はtrue

Throws:

FileException指定されたファイルが存在しない場合

Examples:

import std.exception : assertThrown;

auto dir = deleteme ~ "dir";
auto f = deleteme ~ "f";
scope(exit) dir.rmdir, f.remove;

assert(!dir.exists);
assertThrown!FileException(dir.isDir);

dir.mkdir;
assert(dir.isDir);

f.write(".");
assert(!f.isDir);

pure nothrow @nogc @safe bool attrIsDir(uint attributes);

指定されたファイル属性がディレクトリのものかどうかを返す。

Parameters:

uint attributes ファイル属性

Returns:

attributesがディレクトリを指定する場合はtrue

Examples:

import std.exception : assertThrown;

auto dir = deleteme ~ "dir";
auto f = deleteme ~ "f";
scope(exit) dir.rmdir, f.remove;

assert(!dir.exists);
assertThrown!FileException(dir.getAttributes.attrIsDir);

dir.mkdir;
assert(dir.isDir);
assert(dir.getAttributes.attrIsDir);

f.write(".");
assert(!f.isDir);
assert(!f.getAttributes.attrIsDir);

@property bool isFile(R)(R name) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); @property bool isFile(R)(auto ref R name) if (isConvertibleToString!R);

指定されたファイル(またはディレクトリ)がファイルであるかどうかを返す。

Windowsでは、ファイルがディレクトリでなければファイルである。つまりまたは isFileまたはisDir 、与えられたファイルに対して真を返す。

POSIXシステムでは、もし isFileがtrue の場合、そのファイルが通常のファイルであることを示す(例えば、ブロック・ノット・デバイスではない)。つまり、POSIXシステム上ではの両方が可能である。 isFileとisDir の両方がfalse になることもある。の両方が可能である(この場合、それは特別なファイルである)。その場合は特別なファイルとなる。 getAttributes を使って属性を取得し、どのような特殊なファイルなのかを知ることができる。であるか、DirEntry を使って、statBuf の結果を得ることができる。 stat どちらの場合も、stat のマニュアル・ページを参照のこと。のマニュアルページを参照のこと。

Parameters:

R name ファイルへのパス。

Returns:

nameがファイルを指定した場合はtrue

Throws:

FileException指定されたファイルが存在しない場合

Examples:

import std.exception : assertThrown;

auto dir = deleteme ~ "dir";
auto f = deleteme ~ "f";
scope(exit) dir.rmdir, f.remove;

dir.mkdir;
assert(!dir.isFile);

assert(!f.exists);
assertThrown!FileException(f.isFile);

f.write(".");
assert(f.isFile);

pure nothrow @nogc @safe bool attrIsFile(uint attributes);

指定されたファイル属性がファイルのものかどうかを返す。

Windowsでは、ファイルがディレクトリでなければファイルである。したがって attrIsFiletrue またはattrIsDir は属性を返す。

POSIXシステムでは、もし attrIsFileがtrue の場合である場合、それは通常のファイルであることを示す(例えば、ブロック・ノット・デバイスではない)。つまり、POSIXシステムではの両方が可能である。 attrIsFileとattrIsDir の両方がfalse であることがある(この場合、そのファイルは特殊なファイルである)。ファイルがファイルが特殊ファイルである場合、属性を使ってどのような種類の特殊ファイルであるかを調べることができる( のマニュアル・ページを参照)。をチェックすることができる(詳しくはstat のマニュアル・ページを参照)。

Parameters:

uint attributes ファイルの属性である。

Returns:

与えられたファイル属性がファイルのものであればtrueを返す。

例:

assert(attrIsFile(getAttributes("/etc/fonts/fonts.conf")));
assert(attrIsFile(getLinkAttributes("/etc/fonts/fonts.conf")));

Examples:

import std.exception : assertThrown;

auto dir = deleteme ~ "dir";
auto f = deleteme ~ "f";
scope(exit) dir.rmdir, f.remove;

dir.mkdir;
assert(!dir.isFile);
assert(!dir.getAttributes.attrIsFile);

assert(!f.exists);
assertThrown!FileException(f.getAttributes.attrIsFile);

f.write(".");
assert(f.isFile);
assert(f.getAttributes.attrIsFile);

@property bool isSymlink(R)(R name) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); @property bool isSymlink(R)(auto ref R name) if (isConvertibleToString!R);

指定されたファイルがシンボリックリンクであるかどうかを返す。

Windowsでは、ファイルがシンボリックリンクまたはジャンクション・ポイントである場合、true を返す。ジャンクションポイントである場合に返す。

Parameters:

R name ファイルへのパス。

Returns:

名前がシンボリックリンクの場合は真

Throws:

FileException指定されたファイルが存在しない場合

Examples:

import std.exception : assertThrown;

auto source = deleteme ~ "source";
auto target = deleteme ~ "target";

assert(!source.exists);
assertThrown!FileException(source.isSymlink);

// symlinkingはWindowsでは利用できない
version (Posix)
{
    scope(exit) source.remove, target.remove;

    target.write("target");
    target.symlink(source);
    writeln(source.readText); // "target"
    assert(source.isSymlink);
    assert(source.getLinkAttributes.attrIsSymlink);
}

pure nothrow @nogc @safe bool attrIsSymlink(uint attributes);

指定されたファイル属性がシンボリックリンクであるかどうかを返す。

Windowsでは、ファイルがシンボリックリンクかジャンクションポイントである場合、true を返す。ジャンクション・ポイントである場合に返す。

Parameters:

uint attributes ファイルの属性である。

Returns:

属性がシンボリックリンクの場合はtrue

例:」である。

core.sys.posix.unistd.symlink("/etc/fonts/fonts.conf", "/tmp/alink");

assert(!getAttributes("/tmp/alink").isSymlink);
assert(getLinkAttributes("/tmp/alink").isSymlink);

Examples:

import std.exception : assertThrown;

auto source = deleteme ~ "source";
auto target = deleteme ~ "target";

assert(!source.exists);
assertThrown!FileException(source.getLinkAttributes.attrIsSymlink);

// symlinkingはWindowsでは利用できない
version (Posix)
{
    scope(exit) source.remove, target.remove;

    target.write("target");
    target.symlink(source);
    writeln(source.readText); // "target"
    assert(source.isSymlink);
    assert(source.getLinkAttributes.attrIsSymlink);
}

void chdir(R)(R pathname) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); void chdir(R)(auto ref R pathname) if (isConvertibleToString!R);

ディレクトリを次のように変更する。 pathname.WindowsおよびPOSIXのcd に相当する。に相当する。

Parameters:

R pathname 踏み込むディレクトリ

Throws:

FileExceptionエラー時に

Examples:

import std.algorithm.comparison : equal;
import std.algorithm.sorting : sort;
import std.array : array;
import std.path : buildPath;

auto cwd = getcwd;
auto dir = deleteme ~ "dir";
dir.mkdir;
scope(exit) cwd.chdir, dir.rmdirRecurse;

dir.buildPath("a").write(".");
dir.chdir; // ディレクトリに入る
"b".write(".");
assert(dirEntries(".", SpanMode.shallow).array.sort.equal(
    [".".buildPath("a"), ".".buildPath("b")]
));

void mkdir(R)(R pathname) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); void mkdir(R)(auto ref R pathname) if (isConvertibleToString!R);

新しいディレクトリを作る pathname.

Parameters:

R pathname 作成するディレクトリのパス

Throws:

FileExceptionを作成するディレクトリのパスを指定する。 WindowsExceptionWindowsの場合はでエラーが発生した場合

Examples:

import std.file : mkdir;

auto dir = deleteme ~ "dir";
scope(exit) dir.rmdir;

dir.mkdir;
assert(dir.exists);

Examples:

import std.exception : assertThrown;
assertThrown("a/b/c/d/e".mkdir);

@safe void mkdirRecurse(scope const(char)[] pathname);

必要に応じて、ディレクトリとすべての親ディレクトリを作成する。

で指定されたディレクトリが pathnameで指定されたディレクトリが既に存在する場合は何もしない。

Parameters:

const(char)[] pathname 作成するディレクトリのフルパス

Throws:

FileExceptionを指定する。

Examples:

import std.path : buildPath;

auto dir = deleteme ~ "dir";
scope(exit) dir.rmdirRecurse;

dir.mkdir;
assert(dir.exists);
dir.mkdirRecurse; // 何もしない

// 必要に応じてすべての親ディレクトリを作成する
auto nested = dir.buildPath("a", "b", "c");
nested.mkdirRecurse;
assert(nested.exists);

Examples:

import std.exception : assertThrown;

scope(exit) deleteme.remove;
deleteme.write("a");

// すでにファイルなので、ディレクトリは作れない
assertThrown!FileException(deleteme.mkdirRecurse);

void rmdir(R)(R pathname) if (isSomeFiniteCharInputRange!R && !isConvertibleToString!R); void rmdir(R)(auto ref R pathname) if (isConvertibleToString!R);

ディレクトリを削除する pathname.

Parameters:

R pathname ディレクトリ名を指定する範囲または文字列

Throws:

FileExceptionを指定する。

Examples:

auto dir = deleteme ~ "dir";

dir.mkdir;
assert(dir.exists);
dir.rmdir;
assert(!dir.exists);

void symlink(RO, RL)(RO original, RL link) if ((isSomeFiniteCharInputRange!RO || isConvertibleToString!RO) && (isSomeFiniteCharInputRange!RL || isConvertibleToString!RL));

この関数はPOSIX専用である。

シンボリックリンク(symlink)を作成する。

Parameters:

RO `original`	リンク先のファイル。これはシンボリックリンクに格納される。相対パスは、作成されたシンボリックリンクからの相対パスである。
RL `link`	作成するシンボリックリンク。相対パスは相対パスは、現在の作業ディレクトリからの相対パスである。

Throws:

FileExceptionエラー時に (シンボリックリンクがすでに存在する場合も含む) が存在する場合も含む)。

string readLink(R)(R link) if (isSomeFiniteCharInputRange!R || isConvertibleToString!R);

この関数は POSIX-Only である。

シンボリックリンクが指すファイルへのパスを返す。注釈:」である。パスは、シンボリックリンクによって相対パスにも絶対パスにもなることに注意すること。相対パスの場合は、シンボリックリンクからの相対パスであり、現在の作業ディレクトリからの相対パスではない。ディレクトリを指す。

Throws:

FileExceptionエラー時に

@trusted string getcwd();

現在の作業ディレクトリを取得する。

Throws:

FileExceptionエラー時に

Examples:

auto s = getcwd();
assert(s.length);

@trusted string thisExePath();

現在の実行ファイルのフルパスを返す。

Returns:

実行ファイルのパスをstring として返す。

Throws:

Exception

Examples:

import std.path : isAbsolute;
auto path = thisExePath();

assert(path.exists);
assert(path.isAbsolute);
assert(path.isFile);

struct DirEntry;

POSIXシステムでstatから得られるような、ファイルに関する情報。

@safe this(return scope string path);

与えられたファイル(またはディレクトリ)に対してDirEntry を構築する。

Parameters:

string path DirEntry を取得するファイル (またはディレクトリ)。

Throws:

FileExceptionファイルが存在しない場合

const @property @safe string name() return;

このDirEntry で表されるファイルへのパスを返す。

例:

auto de1 = DirEntry("/etc/fonts/fonts.conf");
assert(de1.name == "/etc/fonts/fonts.conf");

auto de2 = DirEntry("/usr/share/include");
assert(de2.name == "/usr/share/include");

@property @safe bool isDir();

このDirEntry で表されるファイルがディレクトリであるかどうかを返す。

例:

auto de1 = DirEntry("/etc/fonts/fonts.conf");
assert(!de1.isDir);

auto de2 = DirEntry("/usr/share/include");
assert(de2.isDir);

@property @safe bool isFile();

このDirEntry で表されるファイルがファイルであるかどうかを返す。

Windowsでは、ファイルがディレクトリでなければファイルである。つまりまたは isFileまたはisDir はtrue を返す。

POSIXシステムでは、もし isFileがtrue の場合はである場合、そのファイルは通常のファイルであることを示す(例えば、ブロック・ノット・デバイスではない)。つまり POSIXシステムでは、"@system"と isFileとisDir の両方が可能である。 false の両方が可能である(この場合、それは特別なファイルである)。ファイルである)。attributes 、またはstatBuf 。を使用することができる。を参照のこと)。

例:

auto de1 = DirEntry("/etc/fonts/fonts.conf");
assert(de1.isFile);

auto de2 = DirEntry("/usr/share/include");
assert(!de2.isFile);

@property @safe bool isSymlink();

このDirEntry で表されるファイルがシンボリックリンクであるかどうかを返す。シンボリックリンクであるかどうかを返す。

Windowsでは、ファイルがシンボリックリンクかジャンクション・ポイントである場合、true を返す。リンクまたはジャンクション・ポイントである場合にを返す。

@property @safe ulong size();

で表されるファイルのサイズをバイト数で返す。DirEntry で表されるファイルのサイズをバイト数で返す。

const @property @safe SysTime timeCreated();

この関数はWindows専用である。

で表されるファイルの作成時刻を返す。 DirEntry.

@property @safe SysTime timeLastAccessed();

このDirEntry で表されるファイルが最後にアクセスされた時刻を返す。最後にアクセスされた時刻を返す。

多くのファイルシステムは、ファイルのアクセス時刻を更新しないことに注意。 (のアクセス時刻を更新しない(一般的にはパフォーマンス上の理由から)。 timeLastAccessedと同じ値を返す可能性が高い。 timeLastModified.

@property @safe SysTime timeLastModified();

このDirEntry で表されるファイルが最後に更新された時刻を返す。が最後に更新された時刻を返す。

const @property @safe SysTime timeStatusChanged();

この関数はPOSIX専用である。

DirEntry この関数は POSIX-Only である。最後に変更された時刻を返す(内容だけでなく、パーミッションや所有権も)。

@property @safe uint attributes();

この関数は、このDirEntry で表されるファイルの属性を返す。

WindowsとPOSIXシステムのファイル属性は全く異なることに注釈: 。全く異なる。Windowsでは、これらの属性は GetFileAttributes によって返されるものである。で返されるものである。一方、POSIXシステムでは、st_mode の値である。 stat を呼び出すことで得られるstat 構造体の一部である。

POSIXシステムでは、このDirEntry で表されるファイルがシンボリックリンクの場合、attributesはそのファイルの属性となる。 POSIXシステムでは、このが示すファイルがシンボリックリンクである場合、attributesはシンボリックリンクが指すファイルの属性となる。の属性である。

@property @safe uint linkAttributes();

POSIXシステムでは、このDirEntry で表されるファイルがシンボリックリンクの場合、attributesはシンボリックリンクが指すファイルの属性となる。シンボリックリンクである場合 linkAttributesの属性である。である。そうでなければ linkAttributesと同じである。 attributes.

Windowsでは linkAttributesはattributes と同じである。と同じである。シンボリックリンクを扱うときに、Windows用に特別なコードを記述する必要がない。

@property @safe stat_t statBuf();

この関数はPOSIX専用である。

stat を呼び出すと、stat 構造体が得られる。

PreserveAttributes preserveAttributesDefault;

WindowsのデフォルトはYes.preserveAttributes で、その他のプラットフォームではその逆である。

void copy(RF, RT)(RF from, RT to, PreserveAttributes preserve = preserveAttributesDefault) if (isSomeFiniteCharInputRange!RF && !isConvertibleToString!RF && isSomeFiniteCharInputRange!RT && !isConvertibleToString!RT); void copy(RF, RT)(auto ref RF from, auto ref RT to, PreserveAttributes preserve = preserveAttributesDefault) if (isConvertibleToString!RF || isConvertibleToString!RT);

ファイルをコピーする fromをファイルにコピーする。 to.ファイルのタイムスタンプは保持される。もし preserveがYes.preserveAttributes と等しい場合、ファイルの属性は保持される。 Windowsでは、Yes.preserveAttributes (Windowsのデフォルト)のみがサポートされる。ターゲット・ファイルが存在する場合、上書きされる。

Parameters:

RF `from`	既存のファイル名を表す文字列または文字の範囲
RT `to`	ターゲット・ファイル名を表す文字列または文字の範囲
PreserveAttributes `preserve`	ファイル属性を保持するかどうか

Throws:

FileExceptionエラー時に

Examples:

auto source = deleteme ~ "source";
auto target = deleteme ~ "target";
auto targetNonExistent = deleteme ~ "target2";

scope(exit) source.remove, target.remove, targetNonExistent.remove;

source.write("source");
target.write("target");

writeln(target.readText); // "target"

source.copy(target);
writeln(target.readText); // "source"

source.copy(targetNonExistent);
writeln(targetNonExistent.readText); // "source"

@safe void rmdirRecurse(scope const(char)[] pathname); @safe void rmdirRecurse(ref scope DirEntry de); @safe void rmdirRecurse(scope DirEntry de);

ディレクトリとそのすべてのコンテンツとサブディレクトリを削除する、を再帰的に削除する。

Parameters:

const(char)[] `pathname`	完全に削除するディレクトリのパス
DirEntry `de`	ディレクトリの DirEntryを削除する。

Throws:

FileExceptionエラーがあった場合(与えられたファイルがディレクトリでない場合も含む)。

Examples:

import std.path : buildPath;

auto dir = deleteme.buildPath("a", "b", "c");

dir.mkdirRecurse;
assert(dir.exists);

deleteme.rmdirRecurse;
assert(!dir.exists);
assert(!deleteme.exists);

enum SpanMode: int;

dirEntriesのディレクトリスパニングポリシーを指示する(下記参照)。

Examples:

import std.algorithm.comparison : equal;
import std.algorithm.iteration : map;
import std.algorithm.sorting : sort;
import std.array : array;
import std.path : buildPath, relativePath;

auto root = deleteme ~ "root";
scope(exit) root.rmdirRecurse;
root.mkdir;

root.buildPath("animals").mkdir;
root.buildPath("animals", "cat").mkdir;

alias removeRoot = (return scope e) => e.relativePath(root);

assert(root.dirEntries(SpanMode.depth).map!removeRoot.equal(
    [buildPath("animals", "cat"), "animals"]));

assert(root.dirEntries(SpanMode.breadth).map!removeRoot.equal(
    ["animals", buildPath("animals", "cat")]));

root.buildPath("plants").mkdir;

assert(root.dirEntries(SpanMode.shallow).array.sort.map!removeRoot.equal(
    ["animals", "plants"]));

shallow: 1つのディレクトリにのみスパンする。
depth: ディレクトリを post すなわち、どのサブディレクトリの内容も、そのサブディレクトリ自体の前にスパンされる。サブディレクトリの内容が、そのサブディレクトリ自体の前にある。便利である。ファイルを再帰的に削除する場合など。
breadth: ディレクトリを深さ優先 pre-順に走査する。の直後にスパンされる。
注釈: この場合 SpanMode.breadthはすべてのディレクトリのメンバがサブディレクトリのメンバより前になることはない。真のつまり、真の幅優先走査ではない。

auto dirEntries(bool useDIP1000 = dip1000Enabled)(string path, SpanMode mode, bool followSymlink = true); auto dirEntries(bool useDIP1000 = dip1000Enabled)(string path, string pattern, SpanMode mode, bool followSymlink = true);

入力範囲 DirEntry の入力範囲を返す、また、2通りのforeach反復を提供する。イテレーション変数は string 。DirEntry である。スパン・モードはディレクトリがどのように走査されるかを決定する。反復される各ディレクトリエントリの名前の名前には、絶対パスか相対パスが含まれる(パス名による)。

注釈返されるディレクトリエントリの順序は、オペレーティングシステム/ ファイルシステムによって提供されるものである。オペレーティングシステム/ファイルシステムによって提供されるものであり、特定のソートに従っているわけではない。

Parameters:

useDIP1000	この関数は、-preview=dip1000コンパイラ・スイッチのあるコードとないコードで別々にインスタンス化するために使用される。と-preview=dip1000コンパイラ・スイッチのないコードでは、この関数を別々にインスタンス化する必要がある。この関数のABIに影響するからである。自動的に設定される。触らない。
string `path`	反復処理するディレクトリ。空の場合、カレントディレクトリが反復される。
string `pattern`	.d "のようなワイルドカードを持つオプションの文字列。この文字列がある場合の結果をファイル名で絞り込むために使われる。サポートされるワイルドカード文字列については std.path.globMatch.
SpanMode `mode`	ディレクトリのサブディレクトリをにするかどうか。depth), 深さ優先プレオーダー (breadth)、あるいはまったく (shallow).
bool `followSymlink`	ディレクトリを指すシンボリックリンクをディレクトリを指すシンボリックリンクをディレクトリとして扱いを反復処理するかどうか。

Returns:

入力範囲 DirEntry.

Throws:

FileExceptionpath ディレクトリが存在しないか、読み取りパーミッションが拒否されている場合。
FileExceptionmode がshallow でなく、サブディレクトリが読めない場合。

例:

// ディレクトリを深く反復する
foreach (string name; dirEntries("destroy/me", SpanMode.depth))
{
    remove(name);
}

// 現在のディレクトリを反復処理する
foreach (string name; dirEntries("", SpanMode.breadth))
{
    writeln(name);
}

// ディレクトリを反復処理し、その詳細情報を取得する
foreach (DirEntry e; dirEntries("dmd-testing", SpanMode.breadth))
{
    writeln(e.name, "\t", e.size);
}

// 現在のディレクトリとそのすべてのサブディレクトリにあるすべての*.dファイルを反復処理する
auto dFiles = dirEntries("", SpanMode.depth).filter!(f => f.name.endsWith(".d"));
foreach (d; dFiles)
    writeln(d.name);

// std.parallelismとフックして、それらすべてを並列にコンパイルする:
foreach (d; parallel(dFiles, 1)) //各スレッドに1ファイルずつ渡す
{
    string cmd = "dmd -c "  ~ d.name;
    writeln(cmd);
    std.process.executeShell(cmd);
}

// Iterate over all D source files in current directory and all its
// subdirectories
auto dFiles = dirEntries("","*.{d,di}",SpanMode.depth);
foreach (d; dFiles)
    writeln(d.name);

読み取りパーミッションが拒否されたサブディレクトリを扱うには、SpanMode.shallow を使う:

void scan(string path)
{
    foreach (DirEntry entry; dirEntries(path, SpanMode.shallow))
    {
        try
        {
            writeln(entry.name);
            if (entry.isDir)
                scan(entry.name);
        }
        catch (FileException fe) { continue; } // 無視する
    }
}

scan("");

Examples:

D1のstd.file.listdir() :

string[] listdir(string pathname)
{
    import std.algorithm.iteration : map, filter;
    import std.array : array;
    import std.path : baseName;

    return dirEntries(pathname, SpanMode.shallow)
        .filter!(a => a.isFile)
        .map!((return a) => baseName(a.name))
        .array;
}

// preview=dip1000でのみ安全である
@safe void main(string[] args)
{
    import std.stdio : writefln;

    string[] files = listdir(args[1]);
    writefln("%s", files);
}

Select!(Types.length == 1, Types[0][], Tuple!Types[]) slurp(Types...)(string filename, scope const(char)[] format);

ファイルを1行ずつ読み、その行を1つの値または std.typecons.TupleTypes の長さに応じて、単一の値または複数の値に解析される。行は、指定されたフォーマット文字列を使って解析される。フォーマット文字列はに渡される。 std.format.formattedReadに渡されるのでで説明されている書式文字列仕様に準拠しなければならない。 std.format.

Parameters:

Types	行の各要素が返すべき型は以下の通りである。
string `filename`	読み込むファイル名
const(char)[] `format`	読み込み時に使用するフォーマット文字列

Returns:

型が1つしか渡されない場合は、その型の配列となる。それ以外の場合はの配列となる。 std.typecons.Tuples.

Throws:

Exception をスローする。また、次のようにスローされる。をスローする。をスローする。Exceptionstd.format.formattedRead.つまり、空行や余分な文字を含む余分な文字を含む行は許されない。

Examples:

import std.typecons : tuple;

scope(exit)
{
    assert(exists(deleteme));
    remove(deleteme);
}

write(deleteme, "12 12.25\n345 1.125"); // deleteemeは一時ファイルの名前である

// ファイル読込み; 各行はintの後にカンマ、空白、doubleが
// 続く。
auto a = slurp!(int, double)(deleteme, "%s %s");
writeln(a.length); // 2
writeln(a[0]); // tuple(12, 12.25)
writeln(a[1]); // tuple(345, 1.125)

@trusted string tempDir();

一時ファイル用ディレクトリへのパスを返す。 POSIXプラットフォームでは、次のようなディレクトリのリストを検索してを検索し、最初に存在したものを返す:

環境変数TMPDIR で指定されたディレクトリ。
環境変数TEMP で指定されたディレクトリ。
環境変数TMP で指定されたディレクトリ。
/tmp/
/var/tmp/
/usr/tmp/

すべてのプラットフォームで使用できる、 tempDirは失敗すると現在の作業ディレクトリを返す。

この関数の戻り値はキャッシュされるので、以下に説明する手続きは、この関数が最初に呼ばれたときにのみ実行される。関数の戻り値はキャッシュされるので、以下に説明する手続きは、この関数が最初に呼ばれたときにのみ実行される。それ以降それ以降の実行は、環境変数やディレクトリ構造が環境変数やディレクトリ構造がその間に変更されたかどうかに関係なく、それ以降の実行はすべて同じ文字列を返す。を返す。

POSIXの tempDirアルゴリズムはPythonの tempfile.tempdir.

Returns:

Windowsでは、この関数はWindows API関数を呼び出した結果を返す。 GetTempPath.

POSIXプラットフォームでは、この関数は以下のディレクトリのリストを検索し、存在することがわかった最初のディレクトリを返す。を検索し、最初に存在するものを返す:

環境変数TMPDIR で指定されたディレクトリ。
環境変数TEMP で指定されたディレクトリ。
環境変数TMP で指定されたディレクトリ。
/tmp
/var/tmp
/usr/tmp

すべてのプラットフォームにおいて、 tempDirは失敗すると"." を返す。を返す。

Examples:

import std.ascii : letters;
import std.conv : to;
import std.path : buildPath;
import std.random : randomSample;
import std.utf : byCodeUnit;

// 20文字のランダムID
auto id = letters.byCodeUnit.randomSample(20).to!string;
auto myFile = tempDir.buildPath(id ~ "my_tmp_file");
scope(exit) myFile.remove;

myFile.write("hello");
writeln(myFile.readText); // "hello"

@safe ulong getAvailableDiskSpace(scope const(char)[] path);

指定されたパスに基づく利用可能なディスク容量を返す。 Windowsでは pathはディレクトリでなければならないが、POSIXシステムではファイルでもディレクトリでもよい。

Parameters:

const(char)[] path Windowsではディレクトリでなければならないが、POSIXシステムではファイルでもディレクトリでもよい。

Returns:

利用可能なバイト数

Throws:

FileException故障の場合

Examples:

import std.exception : assertThrown;

auto space = getAvailableDiskSpace(".");
assert(space > 0);

assertThrown!FileException(getAvailableDiskSpace("ThisFileDoesNotExist123123"));

DEEPL APIにより翻訳、ところどころ修正。
このページの最新版(英語)
このページの原文(英語)
翻訳時のdmdのバージョン: 2.108.0
ドキュメントのdmdのバージョン: 2.109.1
翻訳日付 :2024-04-15 10:58:31+09:00
HTML生成日時: 2025-01-09 08:11:55+09:00
編集者: dokutoku

言語リファレンス

std.file