StormByte::Buffer::ExternalWriter Class Reference

Interface for writing data to an external source. More...

#include <external.hxx>

Inheritance diagram for StormByte::Buffer::ExternalWriter:

Collaboration diagram for StormByte::Buffer::ExternalWriter:

Public Member Functions
	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.
virtual bool	Write (DataType &&in) noexcept=0
	Move data from the provided buffer.

Detailed Description

Interface for writing data to an external source.

This class defines the interface for writing data to an external source such as a file, network socket, or other I/O stream.

Note

This class is intended to be used as a base class for specific implementations that handle different types of external data sources.

Constructor & Destructor Documentation

ExternalWriter() [1/2]

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

default

Copy constructor.

Parameters

other

ExternalWriter to copy from.

ExternalWriter() [2/2]

StormByte::Buffer::ExternalWriter::ExternalWriter ( ExternalWriter &&  other )

defaultnoexcept

Move constructor.

Parameters

other

ExternalWriter to move from.

Member Function Documentation

operator=() [1/2]

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

default

Copy assignment operator.

Parameters

other

ExternalWriter to copy from.

Returns

Reference to this ExternalWriter.

operator=() [2/2]

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

defaultnoexcept

Move assignment operator.

Parameters

other

ExternalWriter to move from.

Returns

Reference to this ExternalWriter.

Write()

virtual bool StormByte::Buffer::ExternalWriter::Write ( DataType &&  in )

pure virtualnoexcept

Move data from the provided buffer.

Parameters

in	DataType containing data to move.

Returns

true if data was successfully written, false otherwise.

Implemented in StormByte::Buffer::ExternalBufferWriter.

---

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

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