IStreamFile /

#include “cinder/Stream.h”

Typedefs:

IStreamFileRef

Class Hierarchy:

Enums

Endianness
{
- STREAM_BIG_ENDIAN
- STREAM_LITTLE_ENDIAN
}

Public Member Functions

~IStreamFile ()
size_t

readDataAvailable (void *dest, size_t maxSize)
void

seekAbsolute (off_t absoluteOffset)

Sets the current position of the stream to byte absoluteOffset . A negative offset is relative to the end of the file.
void

seekRelative (off_t relativeOffset)

Moves the current position of the stream by relativeOffset bytes.
off_t

tell () const

Returns the current position of the stream measured in bytes **/.
off_t

size () const
bool

isEof () const
FILE *

getFILE ()
void

read (T *t)
void

read (std::string *s)

Reads characters until a null terminator.
void

read (fs::path *p)
void

readEndian (T *t, uint8_t endian)
void

readBig (T *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)
const fs::path &

getFileName () const

Returns the file name of the path from which a Stream originated when relevant. Empty string when undefined.
void

setFileName (const fs::path &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 .

Static Public Member Functions

IStreamFileRef

create (FILE *file, bool ownsFile=true, int32_t defaultBufferSize=2048)

Creates a new IStreamFileRef from a C-style file pointer FILE as returned by fopen(). If ownsFile the returned stream will destroy the stream upon its own destruction.
uint8_t

getNativeEndianness ()

Returns the platform's endianness as a StreamBase::Endianness .

Protected Member Functions

IStreamFile (FILE *aFile, bool aOwnsFile=true, int32_t aDefaultBufferSize=2048)
void

IORead (void *t, size_t size)
size_t

readDataImpl (void *dest, size_t maxSize)

Protected Attributes

FILE *

mFile
bool

mOwnsFile
size_t

mBufferSize
size_t

mDefaultBufferSize
std::shared_ptr< uint8_t >

mBuffer
off_t

mBufferOffset
off_t

mBufferFileOffset
off_t

mSize
bool

mSizeCached
fs::path

mFileName
bool

mDeleteOnDestroy
const int

MINIMUM_BUFFER_SIZE

Namespaces

Classes

Modules

Guides

Reference

IStreamFile /

Enums

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes