IStreamUrl /

#include “cinder/Url.h”

Typedefs:

IStreamUrlRef

Class Hierarchy:

IStreamUrl does not currently support proper random access

Enums

Endianness
{
- STREAM_BIG_ENDIAN
- STREAM_LITTLE_ENDIAN
}

Public Member Functions

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
std::string

getUser () const
std::string

getPassword () const
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

IStreamUrlRef

create (const Url &url, const std::string &user="", const std::string &password="", const UrlOptions &options=UrlOptions())

Creates a new IStreamUrlRef from the Url url with an optional login and password.
uint8_t

getNativeEndianness ()

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

Protected Member Functions

IStreamUrl (const std::string &url, const std::string &user, const std::string &password, const UrlOptions &options)
void

IORead (void *t, size_t size)
void

IOWrite (const void *, size_t)

IStreamURL does not yet support writing.

Protected Attributes

std::shared_ptr< IStreamUrlImpl >

mImpl
fs::path

mFileName
bool

mDeleteOnDestroy
const int

MINIMUM_BUFFER_SIZE

Namespaces

Classes

Modules

Guides

Reference

IStreamUrl /

Enums

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes