class Geo IGeoStream

This is the documentation for Enlighten.

class Geo IGeoStream

class Geo::IGeoStream

    └>Geo::IGeoInputStream

An IGeoStream allows you to read/write memory/files in a consistent manner, and is an extension point for users wishing to control where data is stored.

The simplest implementation is

See Also

GeoFileStream which stores/loads content from a file.

Functions

Name

Description

Name

Description

~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.

EndType(u32)

Provide information about the typed data written to the stream.

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)

IsOk()

Tests if the stream is valid.

IsOk()

Tests if the stream is valid.

Read(TIter, TIter)

Read a collection of objects, 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(T &)

Read a single object, returning true on success.

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.

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)

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 fixed size array.

Write(const T &)

Write a single object, returning true on success.

Enums

Name

Description

Name

Description

EStreamMode

An IGeoStream is open in either esmRead or esmWrite mode.



virtual Geo::IGeoInputStream::~IGeoInputStream


public: virtual ~IGeoInputStream()


Deleting a stream should behave like a close operation.