class Geo GeoFileStream

This is the documentation for Enlighten.

class Geo GeoFileStream

class Geo::GeoFileStream

    └>Geo::IGeoStream
        └>Geo::IGeoInputStream

Simple IGeoStream implementation that saves/loads data from a file.

Enums

Name

Description

Name

Description

EStreamFormat

The underlying stream format can be either binary or text.

EStreamMode

An IGeoStream is open in either esmRead or esmWrite mode.

Functions

Name

Description

Name

Description

~GeoFileStream()

close current file, if any

~IGeoInputStream()

Deleting a stream should behave like a close operation.

~IGeoStream()

Deleting a stream should behave like a close operation.

BeginType(TypeId, u32)

Provide information about the typed data written to the stream.

Close()

close current file, if any

EndType(u32)

Provide information about the typed data written to the stream.

GeoFileStream()

create with no attached file

GetPosition()

Return the position of the read/write pointer within the stream (prototype matches ftell)

GetPosition()

Return the position of the read/write pointer within the stream (prototype matches ftell)

GetPosition()

Return the position of the read/write pointer within the stream (prototype matches ftell)

IsEof()

Is the read pointer at the end of the file (as with feof, only returns true if you have read past end)

IsEof()

Is the read/write pointer at the end of the file (as with feof, only returns true if you have read past end)

IsEof()

Is the read/write pointer at the end of the file (as with feof, only returns true if you have read past end)

IsOk()

Tests if the stream is valid.

IsOk()

Tests if the stream is valid.

IsOk(void)

Tests if the stream is valid.

Open(const char *, EStreamMode, EStreamFormat)

close current file, if any, and open filename

Read(T &)

Read a single object, returning true on success.

Read(T(&))

Read a fixed size array.

Read(void *, size_t, size_t)

Read data (prototype matches fread). Prefer to use the templated Read methods.

Read(TIter, TIter)

Read a collection of objects, returning true on success.

Read(void *, size_t, size_t)

Read data (prototype matches fread). Prefer to use the templated Read methods.

ReadImpl(T &, GeoStd::TrueType)

Read a single object, returning true on success.

ReadImpl(T &, GeoStd::FalseType)

Read a single object, returning true on success.

ReadToEnd()

Reads the stream to its end and returns the data as a char array.

ReadToEnd()

Reads the stream to its end and returns the data as a char array.

SetPosition(Geo::u64)

Set the position of the read/write pointer within the stream (prototype matches fseek)

SetPosition(u64)

Set the position of the read/write pointer within the stream (prototype matches fseek)

SetPosition(u64)

Set the position of the read/write pointer within the stream (prototype matches fseek)

Write(const T(&))

Write a fixed size array.

Write(TIter, TIter)

Write a collection of objects, in range [begin, end) as STL-style classes support.

Write(const void *, size_t, size_t)

Write data (prototype matches fwrite). Prefer to use the templated Write methods.

Write(const T &)

Write a single object, returning true on success.

Write(const void *, size_t, size_t)

Write data (prototype matches fwrite). Prefer to use the templated Write methods.