#include <Stream.h>
Inherits cinder::IStream, and cinder::OStream.
Inherited by cinder::IoStreamFile.
Public Types | |
enum | Endianness { STREAM_BIG_ENDIAN, STREAM_LITTLE_ENDIAN } |
Public Member Functions | |
IoStream () | |
virtual | ~IoStream () |
template<typename T > | |
void | read (T *t) |
void | read (std::string *s) |
Reads characters until a null terminator. | |
void | read (ci::fs::path *p) |
template<typename T > | |
void | readEndian (T *t, uint8_t endian) |
template<typename T > | |
void | readBig (T *t) |
template<typename T > | |
void | readLittle (T *t) |
void | readFixedString (char *t, size_t maxSize, bool nullTerminate) |
void | readFixedString (std::string *t, size_t size) |
std::string | readLine () |
void | readData (void *dest, size_t size) |
virtual size_t | readDataAvailable (void *dest, size_t maxSize)=0 |
virtual off_t | size () const =0 |
virtual bool | isEof () const =0 |
const std::string & | getFileName () const |
Returns the file name of the path from which a Stream originated when relevant. Empty string when undefined. | |
void | setFileName (const std::string &aFileName) |
Sets the file name of the path from which a Stream originated when relevant. Empty string when undefined. | |
bool | getDeleteOnDestroy () const |
Returns whether the Stream has been requested to destroy its source upon its own destruction. For example, IStreamFile will delete its source file. Ignored in some types of streams. Defaults to false . | |
void | setDeleteOnDestroy (bool enable=true) |
Sets whether the Stream has been requested to destroy its source upon its own destruction. For example, IStreamFile will delete its source file. Ignored in some types of streams. Defaults to false . | |
virtual off_t | tell () const =0 |
Returns the current position of the stream measured in bytes **/. | |
virtual void | seekAbsolute (off_t absoluteOffset)=0 |
Sets the current position of the stream to byte absoluteOffset. A negative offset is relative to the end of the file. | |
virtual void | seekRelative (off_t relativeOffset)=0 |
Moves the current position of the stream by relativeOffset bytes. | |
void | write (const std::string &s) |
Writes null-terminated string, including terminator. | |
void | write (const ci::fs::path &p) |
template<typename T > | |
void | write (T t) |
void | write (const Buffer &buffer) |
template<typename T > | |
void | writeEndian (T t, uint8_t endian) |
template<typename T > | |
void | writeBig (T t) |
template<typename T > | |
void | writeLittle (T t) |
void | writeData (const void *src, size_t size) |
Static Public Member Functions | |
static uint8_t | getNativeEndianness () |
Public Attributes | |
return | STREAM_BIG_ENDIAN |
Protected Member Functions | |
virtual void | IORead (void *t, size_t size)=0 |
virtual void | IOWrite (const void *t, size_t size)=0 |
Protected Attributes | |
std::string | mFileName |
bool | mDeleteOnDestroy |
Static Protected Attributes | |
static const int | MINIMUM_BUFFER_SIZE = 8 |
enum cinder::StreamBase::Endianness [inherited] |
cinder::IoStream::IoStream | ( | ) |
virtual cinder::IoStream::~IoStream | ( | ) | [virtual] |
void cinder::IStream::read | ( | T * | t ) | [inherited] |
void cinder::IStream::read | ( | std::string * | s ) | [inherited] |
Reads characters until a null terminator.
void cinder::IStream::read | ( | ci::fs::path * | p ) | [inherited] |
void cinder::IStream::readEndian | ( | T * | t, |
uint8_t | endian | ||
) | [inherited] |
void cinder::IStream::readBig | ( | T * | t ) | [inherited] |
void cinder::IStream::readLittle | ( | T * | t ) | [inherited] |
void cinder::IStream::readFixedString | ( | char * | t, |
size_t | maxSize, | ||
bool | nullTerminate | ||
) | [inherited] |
void cinder::IStream::readFixedString | ( | std::string * | t, |
size_t | size | ||
) | [inherited] |
std::string cinder::IStream::readLine | ( | ) | [inherited] |
void cinder::IStream::readData | ( | void * | dest, |
size_t | size | ||
) | [inherited] |
virtual size_t cinder::IStream::readDataAvailable | ( | void * | dest, |
size_t | maxSize | ||
) | [pure virtual, inherited] |
Implemented in cinder::IStreamFile, cinder::IoStreamFile, cinder::IStreamMem, and cinder::IStreamUrl.
virtual off_t cinder::IStream::size | ( | ) | const [pure virtual, inherited] |
Implemented in cinder::IStreamFile, cinder::IoStreamFile, cinder::IStreamMem, and cinder::IStreamUrl.
virtual bool cinder::IStream::isEof | ( | ) | const [pure virtual, inherited] |
Implemented in cinder::IStreamFile, cinder::IoStreamFile, cinder::IStreamMem, and cinder::IStreamUrl.
virtual void cinder::IStream::IORead | ( | void * | t, |
size_t | size | ||
) | [protected, pure virtual, inherited] |
Implemented in cinder::IStreamFile, cinder::IoStreamFile, cinder::IStreamMem, and cinder::IStreamUrl.
static uint8_t cinder::StreamBase::getNativeEndianness | ( | ) | [static, inherited] |
Returns the platform's endianness as a StreamBase::Endianness
const std::string& cinder::StreamBase::getFileName | ( | ) | const [inherited] |
Returns the file name of the path from which a Stream originated when relevant. Empty string when undefined.
void cinder::StreamBase::setFileName | ( | const std::string & | aFileName ) | [inherited] |
Sets the file name of the path from which a Stream originated when relevant. Empty string when undefined.
bool cinder::StreamBase::getDeleteOnDestroy | ( | ) | const [inherited] |
Returns whether the Stream has been requested to destroy its source upon its own destruction. For example, IStreamFile will delete its source file. Ignored in some types of streams. Defaults to false
.
void cinder::StreamBase::setDeleteOnDestroy | ( | bool | enable = true ) |
[inherited] |
Sets whether the Stream has been requested to destroy its source upon its own destruction. For example, IStreamFile will delete its source file. Ignored in some types of streams. Defaults to false
.
virtual off_t cinder::StreamBase::tell | ( | ) | const [pure virtual, inherited] |
Returns the current position of the stream measured in bytes **/.
Implemented in cinder::IStreamFile, cinder::OStreamFile, cinder::IoStreamFile, cinder::IStreamMem, cinder::OStreamMem, and cinder::IStreamUrl.
virtual void cinder::StreamBase::seekAbsolute | ( | off_t | absoluteOffset ) | [pure virtual, inherited] |
Sets the current position of the stream to byte absoluteOffset. A negative offset is relative to the end of the file.
Implemented in cinder::IStreamFile, cinder::OStreamFile, cinder::IoStreamFile, cinder::IStreamMem, cinder::OStreamMem, and cinder::IStreamUrl.
virtual void cinder::StreamBase::seekRelative | ( | off_t | relativeOffset ) | [pure virtual, inherited] |
Moves the current position of the stream by relativeOffset bytes.
Implemented in cinder::IStreamFile, cinder::OStreamFile, cinder::IoStreamFile, cinder::IStreamMem, cinder::OStreamMem, and cinder::IStreamUrl.
void cinder::OStream::write | ( | const std::string & | s ) | [inherited] |
Writes null-terminated string, including terminator.
void cinder::OStream::write | ( | const ci::fs::path & | p ) | [inherited] |
void cinder::OStream::write | ( | T | t ) | [inherited] |
void cinder::OStream::write | ( | const Buffer & | buffer ) | [inherited] |
void cinder::OStream::writeEndian | ( | T | t, |
uint8_t | endian | ||
) | [inherited] |
void cinder::OStream::writeBig | ( | T | t ) | [inherited] |
void cinder::OStream::writeLittle | ( | T | t ) | [inherited] |
void cinder::OStream::writeData | ( | const void * | src, |
size_t | size | ||
) | [inherited] |
virtual void cinder::OStream::IOWrite | ( | const void * | t, |
size_t | size | ||
) | [protected, pure virtual, inherited] |
Implemented in cinder::OStreamFile, cinder::IoStreamFile, and cinder::OStreamMem.
const int cinder::IStream::MINIMUM_BUFFER_SIZE = 8 [static, protected, inherited] |
return cinder::StreamBase::STREAM_BIG_ENDIAN [inherited] |
std::string cinder::StreamBase::mFileName [protected, inherited] |
bool cinder::StreamBase::mDeleteOnDestroy [protected, inherited] |