Base class interface for resource streams. More...

#include <datastream.h>

Inheritance diagram for Mezzanine::Resource::iStreamBase:

Public Member Functions
	iStreamBase ()
	Class constructor.

virtual	~iStreamBase ()
	Class destructor.

virtual Boole	Bad () const =0
	Gets whether or not a critical error was detected in a previous operation in the stream. More...

virtual void	ClearErrors ()=0
	Clears any stored error state on the stream. More...

virtual Boole	EoF () const =0
	Gets whether or not the current position is at the end of the stream. More...

virtual Boole	Fail () const =0
	Gets whether or not an otherwise silent and recoverable error was detected in a previous operation in the stream. More...

virtual StreamSize	GetSize () const =0
	Gets the size of the stream. More...

virtual Boole	IsValid () const =0
	Gets whether or not this stream is intact and ready for operations. More...

Detailed Description

Base class interface for resource streams.

Definition at line 88 of file datastream.h.

Member Function Documentation

virtual Boole Mezzanine::Resource::iStreamBase::Bad ( ) const

pure virtual

Gets whether or not a critical error was detected in a previous operation in the stream.

Returns: Returns true if a critical error has occurred and the stream integrity may be invalid, false otherwise.

virtual void Mezzanine::Resource::iStreamBase::ClearErrors ( )

pure virtual

Clears any stored error state on the stream.

Remarks: This is useful for non-critical errors such as ones that cause "EoF()" or "Fail()" to return true but not "Bad()". Using this to clear critical errors is not advised.

virtual Boole Mezzanine::Resource::iStreamBase::EoF ( ) const

pure virtual

Gets whether or not the current position is at the end of the stream.