Ogre::FileStreamDataStream Class Reference

Common subclass of DataStream for handling data from std::basic_istream. More...

#include <OgreDataStream.h>

Inheritance diagram for Ogre::FileStreamDataStream:

Public Types
enum	AccessMode { READ = 1 , WRITE = 2 }

Public Member Functions
	FileStreamDataStream (const String &name, std::fstream *s, bool freeOnClose=true)
	Construct named read-write stream from an STL stream. More...
	FileStreamDataStream (const String &name, std::fstream *s, size_t size, bool freeOnClose=true)
	Construct named read-write stream from an STL stream, and tell it the size. More...
	FileStreamDataStream (const String &name, std::ifstream *s, bool freeOnClose=true)
	Construct named read-only stream from an STL stream. More...
	FileStreamDataStream (const String &name, std::ifstream *s, size_t size, bool freeOnClose=true)
	Construct named read-only stream from an STL stream, and tell it the size. More...
	FileStreamDataStream (std::fstream *s, bool freeOnClose=true)
	Construct a read-write stream from an STL stream. More...
	FileStreamDataStream (std::ifstream *s, bool freeOnClose=true)
	Construct a read-only stream from an STL stream. More...
	~FileStreamDataStream () override
void	close () override
	Close the stream; this makes further operations invalid. More...
bool	eof () const override
	Returns true if the stream has reached the end. More...
uint16	getAccessMode () const
	Gets the access mode of the stream. More...
virtual String	getAsString ()
	Returns a String containing the entire stream. More...
virtual String	getLine (bool trimAfter=true)
	Returns a String containing the next line of data, optionally trimmed for whitespace. More...
const String &	getName ()
	Returns the name of the stream, if it has one. More...
virtual bool	isReadable () const
	Reports whether this stream is readable. More...
virtual bool	isWriteable () const
	Reports whether this stream is writeable. More...
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info More...
void *	operator new (size_t sz, void *ptr)
	placement operator new More...
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info More...
template<typename T >
DataStream &	operator>> (T &val)
size_t	read (void *buf, size_t count) override
	Read the requisite number of bytes from the stream, stopping at the end of the file. More...
size_t	readLine (char *buf, size_t maxCount, const String &delim="\n") override
	Get a single line from the stream. More...
void	seek (size_t pos) override
	Repositions the read point to a specified byte. More...
size_t	size () const
	Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream. More...
void	skip (long count) override
	Skip a defined number of bytes. More...
virtual size_t	skipLine (const String &delim="\n")
	Skip a single line from the stream. More...
size_t	tell () const override
	Returns the current byte offset from beginning. More...
size_t	write (const void *buf, size_t count) override
	Write the requisite number of bytes from the stream (only applicable to streams that are not read-only) More...

Detailed Description

Common subclass of DataStream for handling data from std::basic_istream.

Member Enumeration Documentation

AccessMode

enum Ogre::DataStream::AccessMode

inherited

Enumerator
READ
WRITE

Constructor & Destructor Documentation

FileStreamDataStream() [1/6]

Ogre::FileStreamDataStream::FileStreamDataStream	(	std::ifstream *	s,
		bool	freeOnClose = true
	)

Construct a read-only stream from an STL stream.

Parameters

s	Pointer to source stream
freeOnClose	Whether to delete the underlying stream on destruction of this class

FileStreamDataStream() [2/6]

Ogre::FileStreamDataStream::FileStreamDataStream	(	std::fstream *	s,
		bool	freeOnClose = true
	)

Construct a read-write stream from an STL stream.

Parameters

s	Pointer to source stream
freeOnClose	Whether to delete the underlying stream on destruction of this class

FileStreamDataStream() [3/6]

Ogre::FileStreamDataStream::FileStreamDataStream	(	const String &	name,
		std::ifstream *	s,
		bool	freeOnClose = true
	)

Construct named read-only stream from an STL stream.

Parameters

name	The name to give this stream
s	Pointer to source stream
freeOnClose	Whether to delete the underlying stream on destruction of this class

FileStreamDataStream() [4/6]

Ogre::FileStreamDataStream::FileStreamDataStream	(	const String &	name,
		std::fstream *	s,
		bool	freeOnClose = true
	)

Construct named read-write stream from an STL stream.

Parameters

name	The name to give this stream
s	Pointer to source stream
freeOnClose	Whether to delete the underlying stream on destruction of this class

FileStreamDataStream() [5/6]

Ogre::FileStreamDataStream::FileStreamDataStream	(	const String &	name,
		std::ifstream *	s,
		size_t	size,
		bool	freeOnClose = true
	)

Construct named read-only stream from an STL stream, and tell it the size.

Remarks

This variant tells the class the size of the stream too, which means this class does not need to seek to the end of the stream to determine the size up-front. This can be beneficial if you have metadata about the contents of the stream already.

Parameters

name	The name to give this stream
s	Pointer to source stream
size	Size of the stream contents in bytes
freeOnClose	Whether to delete the underlying stream on destruction of this class. If you specify 'true' for this you must ensure that the stream was allocated using OGRE_NEW_T with MEMCATEGRORY_GENERAL.

FileStreamDataStream() [6/6]

Ogre::FileStreamDataStream::FileStreamDataStream	(	const String &	name,
		std::fstream *	s,
		size_t	size,
		bool	freeOnClose = true
	)

Construct named read-write stream from an STL stream, and tell it the size.

Remarks

This variant tells the class the size of the stream too, which means this class does not need to seek to the end of the stream to determine the size up-front. This can be beneficial if you have metadata about the contents of the stream already.

Parameters

name	The name to give this stream
s	Pointer to source stream
size	Size of the stream contents in bytes
freeOnClose	Whether to delete the underlying stream on destruction of this class. If you specify 'true' for this you must ensure that the stream was allocated using OGRE_NEW_T with MEMCATEGRORY_GENERAL.

~FileStreamDataStream()

Ogre::FileStreamDataStream::~FileStreamDataStream ( )

override

Member Function Documentation

close()

void Ogre::FileStreamDataStream::close ( )

overridevirtual

Close the stream; this makes further operations invalid.

Implements Ogre::DataStream.

eof()

bool Ogre::FileStreamDataStream::eof ( ) const

overridevirtual

Returns true if the stream has reached the end.

Implements Ogre::DataStream.

getAccessMode()

uint16 Ogre::DataStream::getAccessMode ( ) const

inlineinherited

Gets the access mode of the stream.

getAsString()

virtual String Ogre::DataStream::getAsString ( )

virtualinherited

Returns a String containing the entire stream.

Remarks

This is a convenience method for text streams only, allowing you to retrieve a String object containing all the data in the stream.

getLine()

virtual String Ogre::DataStream::getLine ( bool  trimAfter = true )

virtualinherited

Returns a String containing the next line of data, optionally trimmed for whitespace.

Remarks

This is a convenience method for text streams only, allowing you to retrieve a String object containing the next line of data. The data is read up to the next newline character and the result trimmed if required.

Note

If you used this function, you must open the stream in binary mode, otherwise, it'll produce unexpected results.

Parameters

trimAfter

If true, the line is trimmed for whitespace (as in String.trim(true,true))

getName()

const String& Ogre::DataStream::getName ( )

inlineinherited

Returns the name of the stream, if it has one.

isReadable()

virtual bool Ogre::DataStream::isReadable ( ) const

inlinevirtualinherited

Reports whether this stream is readable.

isWriteable()

virtual bool Ogre::DataStream::isWriteable ( ) const

inlinevirtualinherited

Reports whether this stream is writeable.

operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr )

inlineinherited

operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr, const char *  , int  , const char *    )

inlineinherited

operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr, void *    )

inlineinherited

operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr )

inlineinherited

operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr, const char *  , int  , const char *    )

inlineinherited

operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz )

inlineinherited

operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz, const char *  file, int  line, const char *  func  )

inlineinherited

operator new, with debug line info

operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz, void *  ptr  )

inlineinherited

placement operator new

operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz )

inlineinherited

operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz, const char *  file, int  line, const char *  func  )

inlineinherited

array operator new, with debug line info

operator>>()

template<typename T >

DataStream& Ogre::DataStream::operator>> ( T &  val )

inherited

read()

size_t Ogre::FileStreamDataStream::read ( void *  buf, size_t  count  )

overridevirtual

Read the requisite number of bytes from the stream, stopping at the end of the file.

Parameters

buf	Reference to a buffer pointer
count	Number of bytes to read

Returns

The number of bytes read

Implements Ogre::DataStream.

readLine()

size_t Ogre::FileStreamDataStream::readLine ( char *  buf, size_t  maxCount, const String &  delim = "\n"  )

overridevirtual

Get a single line from the stream.

Remarks

The delimiter character is not included in the data returned, and it is skipped over so the next read will occur after it. The buffer contents will include a terminating character.

Note

If you used this function, you must open the stream in binary mode, otherwise, it'll produce unexpected results.

Parameters

buf	Reference to a buffer pointer
maxCount	The maximum length of data to be read, excluding the terminating character
delim	The delimiter to stop at

Returns

The number of bytes read, excluding the terminating character

Reimplemented from Ogre::DataStream.

seek()

void Ogre::FileStreamDataStream::seek ( size_t  pos )

overridevirtual

Repositions the read point to a specified byte.

Implements Ogre::DataStream.

size()

size_t Ogre::DataStream::size ( ) const

inlineinherited

Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream.

skip()

void Ogre::FileStreamDataStream::skip ( long  count )

overridevirtual

Skip a defined number of bytes.

This can also be a negative value, in which case the file pointer rewinds a defined number of bytes.

Implements Ogre::DataStream.

skipLine()

virtual size_t Ogre::DataStream::skipLine ( const String &  delim = "\n" )

virtualinherited

Skip a single line from the stream.

Note

If you used this function, you must open the stream in binary mode, otherwise, it'll produce unexpected results.

Parameters

delim

The delimiter(s) to stop at

Returns

The number of bytes skipped

Reimplemented in Ogre::MemoryDataStream.

tell()

size_t Ogre::FileStreamDataStream::tell ( ) const

overridevirtual

Returns the current byte offset from beginning.

Implements Ogre::DataStream.

write()

size_t Ogre::FileStreamDataStream::write ( const void *  buf, size_t  count  )

overridevirtual

Write the requisite number of bytes from the stream (only applicable to streams that are not read-only)

Parameters

buf	Pointer to a buffer containing the bytes to write
count	Number of bytes to write

Returns

The number of bytes written

Reimplemented from Ogre::DataStream.

---

The documentation for this class was generated from the following file:

• OgreDataStream.h