D programming Language

Writing

uint writeBlock(void* buffer, uint size)

Write up to size bytes from buffer in the stream, returning the actual number of bytes that were written.

void writeExact(void* buffer, uint size)

Write exactly size bytes from buffer, or throw a WriteError if that could not be done.

uint write(ubyte[] buffer)

Write as much of the buffer as possible, returning the number of bytes written.

void write(byte x)

Write a basic type or counted string. Outside of byte, ubyte, and char, the format is implementation-specific and should only be used in conjunction with read.

void writeLine(char[] s)

Write a line of text, appending the line with an operating-system-specific line ending.

void writeLineW(wchar[] s)

Write a line of text, appending the line with an operating-system-specific line ending. The format is implementation-specific.

void writeString(char[] s)

Write a string of text, throwing WriteError if it could not be fully written.

void writeStringW(wchar[] s)

Write a string of text, throwing WriteError if it could not be fully written. The format is implementation-dependent.

uint printf(char[] format, ...)

uint vprintf(char[] format, va_list args)

Print a formatted string into the stream using printf-style syntax, returning the number of bytes written.

void copyFrom(Stream s)

Copies all data from s into this stream. This may throw ReadError or WriteError on failure. This restores the file position of s so that it is unchanged.

void copyFrom(Stream s, uint count)

Copy a specified number of bytes from the given stream into this one. This may throw ReadError or WriteError on failure. Unlike the previous form, this doesn't restore the file position of s.

Seeking

ulong seek(long offset, SeekPos whence)

Change the current position of the stream. whence is either SeekPos.Set, in which case the offset is an absolute index from the beginning of the stream, SeekPos.Current, in which case the offset is a delta from the current position, or SeekPos.End, in which case the offset is a delta from the end of the stream (negative or zero offsets only make sense in that case). This returns the new file position.

ulong seekSet(long offset)

ulong seekCur(long offset)

ulong seekEnd(long offset)

Aliases for their normal seek counterparts.

ulong position()

void position(ulong pos)

Retrieve or set the file position, identical to calling seek(0, SeekPos.Current) or seek(pos, SeekPos.Set) respectively.

ulong size()

Retrieve the size of the stream in bytes.

bit eof()

Return whether the current file position is the same as the end of the file. This does not require actually reading past the end of the file, as with stdio.

char[] toString()

Read the entire stream and return it as a string.

uint toHash()

Get a hash of the stream by reading each byte and using it in a CRC-32 checksum.

class File : Stream

This subclass is for file system streams.

this()

this(char[] filename)

this(char[] filename, FileMode mode)

Create the stream with no open file, an open file in read and write mode, or an open file with explicit file mode. mode, if given, is a combination of FileMode.In (indicating a file that can be read) and FileMode.Out (indicating a file that can be written). If the file does not exist, it is created.

void open(char[] filename)

void open(char[] filename, FileMode mode)

Open a file for the stream, in an identical manner to the constructors.

void create(char[] filename)

void create(char[] filename, FileMode mode)

Create a file for the stream.

void close()

Close the current file if it is open; otherwise it does nothing.

uint readBlock(void* buffer, uint size)

uint writeBlock(void* buffer, uint size)

ulong seek(long offset, SeekPos rel)

Overrides of the Stream methods.

class MemoryStream : Stream

This subclass reads and constructs an array of bytes in memory.

this()

this(ubyte[] data)

Create the output buffer and setup for reading, writing, and seeking. The second constructor loads it with specific input data.

ubyte[] data()

Get the current memory data in total.

uint readBlock(void* buffer, uint size)

uint writeBlock(void* buffer, uint size)

ulong seek(long offset, SeekPos rel)

char[] toString()

Overrides of Stream methods.

class SliceStream : Stream

This subclass slices off a portion of another stream, making seeking relative to the boundaries of the slice. It could be used to section a large file into a set of smaller files, such as with tar archives.

this(Stream base, int low)

Indicate both the base stream to use for reading from and the low part of the slice. The high part of the slice is dependent upon the end of the base stream, so that if you write beyond the end it resizes the stream normally.

Indicate the high index as well. Attempting to read or write past the high index results in the end being clipped off.

uint readBlock(void* buffer, uint size)

uint writeBlock(void* buffer, uint size)

ulong seek(long offset, SeekPos rel)

Overrides of Stream methods.