StormByte::Buffer::ExternalBufferWriter Class Reference

Inheritance diagram for StormByte::Buffer::ExternalBufferWriter:

Collaboration diagram for StormByte::Buffer::ExternalBufferWriter:

Public Member Functions
	ExternalBufferWriter (WriteOnly &buffer) noexcept
	Construct ExternalBufferWriter with a WriteOnly buffer.
	ExternalBufferWriter (const ExternalBufferWriter &other)=default
	Copy constructor (deleted).
	ExternalBufferWriter (ExternalBufferWriter &&other) noexcept=default
	Move constructor.
	~ExternalBufferWriter () noexcept=default
	Destructor.
ExternalBufferWriter &	operator= (const ExternalBufferWriter &other)=default
	Copy assignment (deleted).
ExternalBufferWriter &	operator= (ExternalBufferWriter &&other) noexcept=default
	Move assignment.
PointerType	Clone () const noexcept override
	Clone this ExternalBufferWriter.
PointerType	Move () noexcept override
	Move this ExternalBufferWriter.
bool	Write (DataType &&in) noexcept override
	Move data from the provided buffer.
Public Member Functions inherited from StormByte::Buffer::ExternalWriter
	ExternalWriter () noexcept=default
	Construct ExternalWriter.
	ExternalWriter (const ExternalWriter &other)=default
	Copy constructor.
	ExternalWriter (ExternalWriter &&other) noexcept=default
	Move constructor.
virtual	~ExternalWriter () noexcept=default
	Destructor.
ExternalWriter &	operator= (const ExternalWriter &other)=default
	Copy assignment operator.
ExternalWriter &	operator= (ExternalWriter &&other) noexcept=default
	Move assignment operator.

Constructor & Destructor Documentation

ExternalBufferWriter() [1/3]

StormByte::Buffer::ExternalBufferWriter::ExternalBufferWriter ( WriteOnly &  buffer )

inlinenoexcept

Construct ExternalBufferWriter with a WriteOnly buffer.

Parameters

buffer

WriteOnly buffer to write to.

Note

The ExternalBufferWriter does NOT take ownership of buffer. The caller is responsible for ensuring that buffer outlives this ExternalBufferWriter instance. The writer stores a reference wrapper to the provided WriteOnly object.

ExternalBufferWriter() [2/3]

StormByte::Buffer::ExternalBufferWriter::ExternalBufferWriter ( const ExternalBufferWriter &  other )

default

Copy constructor (deleted).

Parameters

other

ExternalBufferWriter to copy from.

ExternalBufferWriter() [3/3]

StormByte::Buffer::ExternalBufferWriter::ExternalBufferWriter ( ExternalBufferWriter &&  other )

defaultnoexcept

Move constructor.

Parameters

other

ExternalBufferWriter to move from.

Member Function Documentation

Clone()

PointerType StormByte::Buffer::ExternalBufferWriter::Clone ( ) const

inlineoverridenoexcept

Clone this ExternalBufferWriter.

Returns

Pointer to the cloned ExternalBufferWriter.

Move()

PointerType StormByte::Buffer::ExternalBufferWriter::Move ( )

inlineoverridenoexcept

Move this ExternalBufferWriter.

Returns

Pointer to the moved ExternalBufferWriter.

operator=() [1/2]

ExternalBufferWriter & StormByte::Buffer::ExternalBufferWriter::operator= ( const ExternalBufferWriter &  other )

default

Copy assignment (deleted).

Parameters

other

ExternalBufferWriter to copy from.

Returns

Reference to this ExternalBufferWriter.

operator=() [2/2]

ExternalBufferWriter & StormByte::Buffer::ExternalBufferWriter::operator= ( ExternalBufferWriter &&  other )

defaultnoexcept

Move assignment.

Parameters

other

ExternalBufferWriter to move from.

Returns

Reference to this ExternalBufferWriter.

Write()

bool StormByte::Buffer::ExternalBufferWriter::Write ( DataType &&  in )

overridevirtualnoexcept

Move data from the provided buffer.

Parameters

in	DataType containing data to move.

Returns

true if data was successfully written, false otherwise.

Implements StormByte::Buffer::ExternalWriter.

---

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

• /home/runner/work/StormByte-Buffer/StormByte-Buffer/lib/public/StormByte/buffer/external.hxx