Arp::System::Commons::Io::NullStream Class Reference

Inheritance diagram for Arp::System::Commons::Io::NullStream:

Public Member Functions
	NullStream (void)=default
	Constructs an NullStream instance.
boolean	CanRead (void) final
	Determines if the derived stream can read. More...
boolean	CanWrite (void) final
	Determines if the derived stream can write. More...
boolean	CanSeek (void) final
	Determines if the derived stream can seek. More...
size_t	GetLength (void)
void	SetLength (size_t length)
size_t	GetPosition (void) final
	Gets the position of the stream, if it can seek. More...
void	SetPosition (size_t position) final
	Sets the position of the stream, if it can seek. More...
void	Flush (void) final
size_t	Seek (size_t offset, SeekOrigin origin) final
size_t	Read (byte *pBuffer, size_t bufferSize, size_t offset, size_t count) final
void	Write (const byte *pBuffer, size_t bufferSize, size_t offset, size_t count) final
byte	ReadByte (void) final
	Reads a single byte from the stream. More...
void	WriteByte (byte value) final
	Writes a single byte to the stream. More...
void	Close (void)
Public Member Functions inherited from Arp::Base::Commons::Io::Stream
	Stream (bool canRead=false, bool canWrite=false, bool canSeek=false)
	This constructor is used to constructs a base stream instance. More...
	Stream (const Stream &arg)
	Default copy constructor. More...
	Stream (Stream &&arg) noexcept
	Default move constructor. More...
Stream &	operator= (const Stream &arg)
	Default copy-assignment operator. More...
Stream &	operator= (Stream &&arg) noexcept
	Default move-assignment operator. More...
virtual	~Stream (void)
	Default destructor.
virtual bool	CanRead (void)
	Determines if the derived stream can read. More...
virtual bool	CanWrite (void)
	Determines if the derived stream can write. More...
virtual bool	CanSeek (void)
	Determines if the derived stream can seek. More...
virtual void	SetPosition (size_t value)
	Sets the position of the stream, if it can seek. More...
virtual size_t	GetPosition (void)
	Gets the position of the stream, if it can seek. More...
virtual size_t	Seek (size_t offset, SeekOrigin origin)=0
virtual size_t	Read (byte *pBuffer, size_t bufferSize, size_t bufferOffset, size_t count)=0
virtual void	Write (const byte *pBuffer, size_t bufferSize, size_t bufferOffset, size_t count)=0
virtual void	Flush (void)=0
virtual byte	ReadByte (void)
	Reads a single byte from the stream. More...
virtual void	WriteByte (byte value)
	Writes a single byte to the stream. More...
virtual void	WriteTo (Stream &other)
	Writes the data this stream to another stream entirely. More...
virtual void	ReadFrom (Stream &other)
	Reads the entire data from another stream into this stream. More...

Protected Member Functions
void	InternalDispose (void)

Additional Inherited Members
Static Public Member Functions inherited from Arp::Base::Commons::Io::Stream
static Stream &	GetEmpty (void)
	Gets an empty stream. More...

Member Function Documentation

CanRead()

boolean Arp::System::Commons::Io::NullStream::CanRead ( void  )

finalvirtual

Determines if the derived stream can read.

Returns

true if the derived stream can read, otherwise false.

Reimplemented from Arp::Base::Commons::Io::Stream.

CanSeek()

boolean Arp::System::Commons::Io::NullStream::CanSeek ( void  )

finalvirtual

Determines if the derived stream can seek.

Returns

true if the derived stream can seek, otherwise false.

Reimplemented from Arp::Base::Commons::Io::Stream.

CanWrite()

boolean Arp::System::Commons::Io::NullStream::CanWrite ( void  )

finalvirtual

Determines if the derived stream can write.

Returns

true if the derived stream can write, otherwise false.

Reimplemented from Arp::Base::Commons::Io::Stream.

Flush()

void Arp::System::Commons::Io::NullStream::Flush ( void  )

finalvirtual

Implements Arp::Base::Commons::Io::Stream.

GetPosition()

size_t Arp::System::Commons::Io::NullStream::GetPosition ( void  )

finalvirtual

Gets the position of the stream, if it can seek.

Parameters

value

The current position of the stream.

Exceptions

NotSupportedException

If this stream cannot seek.

Reimplemented from Arp::Base::Commons::Io::Stream.

Read()

size_t Arp::System::Commons::Io::NullStream::Read ( byte *  pBuffer, size_t  bufferSize, size_t  offset, size_t  count  )

finalvirtual

Implements Arp::Base::Commons::Io::Stream.

ReadByte()

byte Arp::System::Commons::Io::NullStream::ReadByte ( void  )

finalvirtual

Reads a single byte from the stream.

Returns

The read byte.

Exceptions

EndOfStreamException

If this stream is at its end.

Reimplemented from Arp::Base::Commons::Io::Stream.

SetPosition()

void Arp::System::Commons::Io::NullStream::SetPosition ( size_t  value )

finalvirtual

Sets the position of the stream, if it can seek.

Parameters

value

The new position of the stream.

Exceptions

NotSupportedException

If this stream cannot seek.

Reimplemented from Arp::Base::Commons::Io::Stream.

Write()

void Arp::System::Commons::Io::NullStream::Write ( const byte *  pBuffer, size_t  bufferSize, size_t  offset, size_t  count  )

finalvirtual

Implements Arp::Base::Commons::Io::Stream.

WriteByte()

void Arp::System::Commons::Io::NullStream::WriteByte ( byte  value )

finalvirtual

Writes a single byte to the stream.

Parameters

value

The byte to write.

Reimplemented from Arp::Base::Commons::Io::Stream.

---

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

• Arp/System/Commons/Io/NullStream.hpp
• Arp/System/Commons/Io/NullStream.cpp