Menu
Search

API Documentation

version 2.109.0

overview

View source code
Display the source code in std/file.d from which this page was generated on github.
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
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.

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.

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);

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.

See Also

readText for reading and validating a text file.

Example

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

write(deleteme, "1234"); // deleteme is the name of a temporary file
writeln(read(deleteme, 2)); // "12"
writeln(read(deleteme.byChar)); // "1234"
writeln((cast(const(ubyte)[])read(deleteme)).length); // 4

Authors

Walter Bright, Andrei Alexandrescu, Jonathan M Davis

License

Boost License 1.0.