Core class that represents a stream of bytes. More...

Inheritance diagram for Nz::ByteStream:

Public Member Functions
	ByteStream (Stream *stream=nullptr)
	Constructs a ByteStream object with a stream.

	ByteStream (ByteArray *byteArray, OpenModeFlags openMode=OpenMode_ReadWrite)
	Constructs a ByteStream object with a byte array. More...

	ByteStream (void *ptr, Nz::UInt64 size)
	Constructs a ByteStream object with a raw memory and a size. More...

	ByteStream (const void *ptr, Nz::UInt64 size)
	Constructs a ByteStream object with a raw memory and a size. More...

	ByteStream (const ByteStream &)=delete

	ByteStream (ByteStream &&stream)
	Constructs a ByteStream object by move semantic. More...

virtual	~ByteStream ()
	Destructs the object and calls FlushBits. More...

Endianness	GetDataEndianness () const
	Gets the stream endianness. More...

Nz::UInt64	GetSize () const
	Gets the size of the byte stream. More...

Stream *	GetStream () const
	Gets the internal stream. More...

bool	FlushBits ()
	Flushes the stream. More...

std::size_t	Read (void *ptr, std::size_t size)
	Reads data. More...

void	SetDataEndianness (Endianness endiannes)
	Sets the stream endianness. More...

void	SetStream (Stream *stream)
	Sets this with a stream. More...

void	SetStream (ByteArray *byteArray, OpenModeFlags openMode=OpenMode_ReadWrite)
	Sets this with a byte array. More...

void	SetStream (void *ptr, Nz::UInt64 size)
	Sets this with a raw memory and a size. More...

void	SetStream (const void *ptr, Nz::UInt64 size)
	Sets this with a raw memory and a size. More...

void	Write (const void *data, std::size_t size)
	Writes data. More...

template<typename T >
ByteStream &	operator>> (T &value)
	Outputs a data from the stream. More...

template<typename T >
ByteStream &	operator<< (const T &value)
	Adds the data to the stream. More...

ByteStream &	operator= (const ByteStream &)=delete

ByteStream &	operator= (ByteStream &&)
	Moves the other byte stream into this. More...

Detailed Description

Core class that represents a stream of bytes.

Constructor & Destructor Documentation

◆ ByteStream() [1/4]

Nz::ByteStream::ByteStream	(	ByteArray *	byteArray,
		OpenModeFlags	openMode = `OpenMode_ReadWrite`
	)

Constructs a ByteStream object with a byte array.

Parameters

byteArray	Bytes to stream
openMode	Reading/writing mode for the stream

◆ ByteStream() [2/4]

Nz::ByteStream::ByteStream	(	void *	ptr,
		Nz::UInt64	size
	)

Constructs a ByteStream object with a raw memory and a size.

Parameters

ptr	Pointer to raw memory
size	Size that can be read

Remarks: If preallocated space of ptr is less than the size, the behaviour is undefined

◆ ByteStream() [3/4]

Nz::ByteStream::ByteStream	(	const void *	ptr,
		Nz::UInt64	size
	)

Constructs a ByteStream object with a raw memory and a size.

Parameters

ptr	Constant pointer to raw memory
size	Size that can be read

Remarks: If preallocated space of ptr is less than the size, the behaviour is undefined

◆ ByteStream() [4/4]

Nz::ByteStream::ByteStream ( ByteStream && stream )

inline

Constructs a ByteStream object by move semantic.

Parameters

stream ByteStream to move into this

◆ ~ByteStream()

Nz::ByteStream::~ByteStream ( )

inlinevirtual

Destructs the object and calls FlushBits.

Remarks: Produces a NazaraWarning if flush did not work

See also: FlushBits

Member Function Documentation

◆ FlushBits()

bool Nz::ByteStream::FlushBits ( )

inline

Flushes the stream.

Returns: true if flushing is successful

◆ GetDataEndianness()

Endianness Nz::ByteStream::GetDataEndianness ( ) const

inline

Gets the stream endianness.

Returns: Type of the endianness

◆ GetSize()

Nz::UInt64 Nz::ByteStream::GetSize ( ) const

inline

Gets the size of the byte stream.

Returns: Size of the stream

◆ GetStream()

Stream * Nz::ByteStream::GetStream ( ) const

inline

Gets the internal stream.

Returns: Internal stream

◆ operator<<()

template<typename T >

ByteStream & Nz::ByteStream::operator<< ( const T & value )

Adds the data to the stream.

Returns: A reference to this

Parameters

value Value to serialize

Remarks: Produces a NazaraError if serialization failed

◆ operator=()

ByteStream & Nz::ByteStream::operator= ( ByteStream && stream )

inline

Moves the other byte stream into this.

Returns: A reference to this

Parameters

stream ByteStream to move in this

◆ operator>>()

template<typename T >

ByteStream & Nz::ByteStream::operator>> ( T & value )

Outputs a data from the stream.

Returns: A reference to this

Parameters

value Value to unserialize

Remarks: Produces a NazaraError if unserialization failed

◆ Read()

std::size_t Nz::ByteStream::Read	(	void *	ptr,
		std::size_t	size
	)

inline

Reads data.

Returns: Number of data read

Parameters

buffer	Preallocated buffer to contain information read
size	Size of the read and thus of the buffer

◆ SetDataEndianness()

void Nz::ByteStream::SetDataEndianness ( Endianness endiannes )

inline

Sets the stream endianness.

Parameters

Type	of the endianness

◆ SetStream() [1/4]

void Nz::ByteStream::SetStream ( Stream * stream )

inline

Sets this with a stream.

Parameters

stream Stream existing

Remarks: Produces a NazaraAssert if stream is invalid

◆ SetStream() [2/4]

void Nz::ByteStream::SetStream	(	ByteArray *	byteArray,
		OpenModeFlags	openMode = `OpenMode_ReadWrite`
	)

Sets this with a byte array.

Parameters

byteArray	Bytes to stream
openMode	Reading/writing mode for the stream

◆ SetStream() [3/4]

void Nz::ByteStream::SetStream	(	void *	ptr,
		Nz::UInt64	size
	)

Sets this with a raw memory and a size.

Parameters

ptr	Pointer to raw memory
size	Size that can be read

Remarks: If preallocated space of ptr is less than the size, the behaviour is undefined

◆ SetStream() [4/4]

void Nz::ByteStream::SetStream	(	const void *	ptr,
		Nz::UInt64	size
	)

Sets this with a raw memory and a size.

Parameters

ptr	Constant pointer to raw memory
size	Size that can be read

Remarks: If preallocated space of ptr is less than the size, the behaviour is undefined

◆ Write()

void Nz::ByteStream::Write	(	const void *	data,
		std::size_t	size
	)

inline

Writes data.

Returns: Number of data written

Parameters

buffer	Preallocated buffer containing information to write
size	Size of the writting and thus of the buffer

Remarks: Produces a NazaraAssert if buffer is nullptr

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

include/Nazara/Core/ByteStream.hpp
include/Nazara/Core/ByteStream.inl
src/Nazara/Core/ByteStream.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ByteStream() [1/4]

◆ ByteStream() [2/4]

◆ ByteStream() [3/4]

◆ ByteStream() [4/4]

◆ ~ByteStream()

Member Function Documentation

◆ FlushBits()

◆ GetDataEndianness()

◆ GetSize()

◆ GetStream()

◆ operator<<()

◆ operator=()

◆ operator>>()

◆ Read()

◆ SetDataEndianness()

◆ SetStream() [1/4]

◆ SetStream() [2/4]

◆ SetStream() [3/4]

◆ SetStream() [4/4]

◆ Write()