View source code Display the source code in std/file.d from which this page was generated on github. Improve this page Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone. Page wiki View or edit the community-maintained wiki page associated with this page.

Function std.file.read

Read entire contents of file name and returns it as an untyped array. If the file size is larger than upTo, only upTo bytes are read.

Prototype

void[] read(R)(
  R name,
  size_t upTo = size_t.max
)
if (isInputRange!R && isSomeChar!(ElementEncodingType!R));

Parameters

NameDescription
name string or range of characters representing the file name
upTo if present, the maximum number of bytes to read

Returns

Untyped array of bytes read.

Throws

FileException on error.

Example

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

write("someUniqueFilename", "1234");
assert(read("someUniqueFilename", 2) == "12");
assert(read("someUniqueFilename".byChar) == "1234");
assert((cast(ubyte[])read("someUniqueFilename")).length == 4);

Authors

Walter Bright, Andrei Alexandrescu, Jonathan M Davis

License

Boost License 1.0.

Comments