gamut.io

I/O streams.

Members

EofProc alias EofProc = int function(IOHandle handle): A function with same signature and semantics than feof. From Linux man: "The function feof() tests the end-of-file indicator for the stream pointed to by stream, returning nonzero if it is set."
IOHandle alias IOHandle = void*: Can be a FILE* handle, a FIMEMORY, a WrappedIO... identifies the I/O stream.
ReadProc alias ReadProc = size_t function(void* buffer, size_t size, size_t count, IOHandle handle): A function with same signature and semantics than fread.
SeekProc alias SeekProc = int function(IOHandle handle, c_long offset, int origin): A function with same signature and semantics than fseek. Origin: position from which offset is added SEEK_SET = beginning of file. SEEK_CUR = Current position of file pointer. SEEK_END = end of file. This function returns zero if successful, or else it returns a non-zero value. Note: c_long offsets in gamut can always be cast to int without loss.
TellProc alias TellProc = c_long function(IOHandle handle): A function with same signature and semantics than ftell. Tells where we are in the file. -1 if error. Note: c_long offsets in gamut can always be cast to int without loss.
WriteProc alias WriteProc = size_t function(const(void)* buffer, size_t size, size_t count, IOHandle handle): A function with same signature and semantics than fwrite.

fileIsStartingWithSignature bool fileIsStartingWithSignature(IOStream* io, IOHandle handle, ubyte[] signature): Undocumented in source. Be warned that the author may not have intended to support it.
meof int meof(MemoryFile* stream): Undocumented in source. Be warned that the author may not have intended to support it.
mread size_t mread(void* buffer, size_t size, size_t count, MemoryFile* stream): Undocumented in source. Be warned that the author may not have intended to support it.
mseek int mseek(MemoryFile* stream, c_long offset, int origin): Undocumented in source. Be warned that the author may not have intended to support it.
mtell c_long mtell(MemoryFile* stream): Undocumented in source. Be warned that the author may not have intended to support it.
mwrite size_t mwrite(void* buffer, size_t size, size_t count, MemoryFile* stream): Undocumented in source. Be warned that the author may not have intended to support it.

SEEK_CUR (from core.stdc.stdio) public import core.stdc.stdio : SEEK_SET, SEEK_CUR, SEEK_END;: Undocumented in source.
SEEK_END (from core.stdc.stdio) public import core.stdc.stdio : SEEK_SET, SEEK_CUR, SEEK_END;: Undocumented in source.
SEEK_SET (from core.stdc.stdio) public import core.stdc.stdio : SEEK_SET, SEEK_CUR, SEEK_END;: Undocumented in source.
c_long (from core.stdc.config) public import core.stdc.config : c_long;: Undocumented in source.

IOStream struct IOStream: I/O abstraction, to support load/write from a file, from memory, or from user-provided callbacks.
MemoryFile struct MemoryFile: This is basically an owned buffer, with capacity, optionally borrowed. The original things being that it can both be used for reading and writing.
WrappedIO struct WrappedIO: Undocumented in source.

GAMUT_MAX_POSSIBLE_MEMORY_OFFSET enum size_t GAMUT_MAX_POSSIBLE_MEMORY_OFFSET;: Can't open file larger than this much bytes
GAMUT_MAX_POSSIBLE_SIMULTANEOUS_READ enum size_t GAMUT_MAX_POSSIBLE_SIMULTANEOUS_READ;: Can't read more bytes than this at once
GAMUT_MAX_POSSIBLE_SIMULTANEOUS_WRITE enum size_t GAMUT_MAX_POSSIBLE_SIMULTANEOUS_WRITE;: Can't write more bytes than this at once