Byte-oriented FIFO buffer with grow-on-demand and close/error support. More...

#include <StormByte/buffer/fifo.hxx>

Inheritance diagram for StormByte::Buffer::FIFO:

[legend]

Collaboration diagram for StormByte::Buffer::FIFO:

[legend]

Public Member Functions
Constructors / destructor / assignment
	FIFO () noexcept=default
	Default construct an empty FIFO.

	FIFO (const DataType &data) noexcept
	Construct FIFO with initial data (copy).

	FIFO (DataType &&data) noexcept
	Construct FIFO with initial data (move).

template<Type::ByteInputRange R> requires (!Type::SameAs<R, DataType>)
	FIFO (const R &r) noexcept
	Construct FIFO from an input range (copy / convert).

template<Type::ByteInputRange Rr>
	FIFO (Rr &&r) noexcept
	Construct FIFO from an rvalue range (moves when DataType).

	FIFO (std::string_view sv) noexcept
	Construct FIFO from a string view (no trailing NUL).

	FIFO (const char *s) noexcept
	Construct FIFO from a null-terminated C string.

	FIFO (const FIFO &other) noexcept
	Copy construct, preserving buffer contents and state.

	FIFO (FIFO &&other) noexcept
	Move construct.

virtual	~FIFO () noexcept
	Virtual destructor.

FIFO &	operator= (const FIFO &other)
	Copy assign, preserving buffer contents and state.

FIFO &	operator= (FIFO &&other) noexcept
	Move assign.

Comparison
bool	operator== (const FIFO &other) const noexcept
	Equality comparison.

bool	operator!= (const FIFO &other) const noexcept
	Inequality comparison.

Queries
virtual std::size_t	AvailableBytes () const noexcept
	Bytes available from the current read position.

virtual const DataType &	Data () const noexcept override
	Access the internal storage.

virtual bool	Empty () const noexcept override
	Whether the underlying storage is empty.

virtual bool	EoF () const noexcept override
	End-of-stream condition.

virtual bool	IsReadable () const noexcept override
	Whether the buffer can be read.

virtual bool	IsWritable () const noexcept override
	Whether the buffer accepts writes.

virtual std::size_t	Size () const noexcept override
	Total number of bytes stored (including already-read prefix).

Maintenance / lifecycle
virtual void	Clean () noexcept override
	Discard data from the start up to the current read position.

virtual void	Clear () noexcept override
	Clear all buffer contents and reset the read position.

void	Close () noexcept override
	Mark the buffer closed for further writes.

virtual bool	Drop (const std::size_t &count) noexcept override
	Discard `count` unread bytes and advance the read position.

virtual void	Seek (const std::ptrdiff_t &offset, const Position &mode) const noexcept override
	Move the logical read position for non-destructive reads.

void	SetError () noexcept override
	Enter permanent error state (unreadable and unwritable).

Extract (destructive)
bool	Extract (const std::size_t &count, DataType &outBuffer) noexcept override
	Extract bytes into a DataType.

bool	Extract (const std::size_t &count, WriteOnly &outBuffer) noexcept override
	Extract bytes into a WriteOnly.

void	ExtractUntilEoF (DataType &outBuffer) noexcept override
	Extract all remaining bytes until EoF into a DataType.

void	ExtractUntilEoF (WriteOnly &outBuffer) noexcept override
	Extract all remaining bytes until EoF into a WriteOnly.

virtual bool	Extract (const std::size_t &count, DataType &outBuffer) noexcept=0
	Bring ReadOnly convenience Extract overloads into scope.

bool	Extract (DataType &outBuffer) noexcept
	Bring ReadOnly convenience Extract overloads into scope.

virtual bool	Extract (const std::size_t &count, WriteOnly &outBuffer) noexcept=0
	Bring ReadOnly convenience Extract overloads into scope.

bool	Extract (WriteOnly &outBuffer) noexcept
	Bring ReadOnly convenience Extract overloads into scope.

Read (non-destructive)
bool	Read (const std::size_t &count, DataType &outBuffer) const noexcept override
	Non-destructive read into a DataType (advances position).

bool	Read (const std::size_t &count, WriteOnly &outBuffer) const noexcept override
	Non-destructive read into a WriteOnly (advances position).

void	ReadUntilEoF (DataType &outBuffer) const noexcept override
	Read all remaining bytes until EoF into a DataType.

void	ReadUntilEoF (WriteOnly &outBuffer) const noexcept override
	Read all remaining bytes until EoF into a WriteOnly.

virtual bool	Read (const std::size_t &count, DataType &outBuffer) const noexcept=0
	Bring ReadOnly convenience Read overloads into scope.

bool	Read (DataType &outBuffer) const noexcept
	Bring ReadOnly convenience Read overloads into scope.

virtual bool	Read (const std::size_t &count, WriteOnly &outBuffer) const noexcept=0
	Bring ReadOnly convenience Read overloads into scope.

bool	Read (WriteOnly &outBuffer) const noexcept
	Bring ReadOnly convenience Read overloads into scope.

Peek (non-destructive, does not advance)
bool	Peek (const std::size_t &count, DataType &outBuffer) const noexcept override
	Peek into a DataType without advancing the read position.

bool	Peek (const std::size_t &count, WriteOnly &outBuffer) const noexcept override
	Peek into a WriteOnly without advancing the read position.

Diagnostics
virtual std::string	HexDump (const std::size_t &columns=16, const std::size_t &byte_limit=0) const noexcept
	Hexdump of unread contents from the current read position.

Write
bool	Write (const std::size_t &count, const DataType &data) noexcept override
	Append bytes from a DataType (copy).

bool	Write (const std::size_t &count, DataType &&data) noexcept override
	Append bytes from a DataType (move).

bool	Write (const std::size_t &count, const ReadOnly &data) noexcept override
	Append bytes from a ReadOnly source (copy).

bool	Write (const std::size_t &count, ReadOnly &&data) noexcept override
	Append bytes from a ReadOnly source (move / extract path).

virtual bool	Write (const std::size_t &count, const DataType &data) noexcept=0
	Bring WriteOnly convenience Write overloads into scope.

virtual bool	Write (const std::size_t &count, DataType &&data) noexcept=0
	Bring WriteOnly convenience Write overloads into scope.

virtual bool	Write (const std::size_t &count, const ReadOnly &data) noexcept=0
	Bring WriteOnly convenience Write overloads into scope.

virtual bool	Write (const std::size_t &count, ReadOnly &&data) noexcept=0
	Bring WriteOnly convenience Write overloads into scope.

bool	Write (const ReadOnly &data) noexcept
	Bring WriteOnly convenience Write overloads into scope.

bool	Write (ReadOnly &&data) noexcept
	Bring WriteOnly convenience Write overloads into scope.

bool	Write (std::string_view sv) noexcept
	Bring WriteOnly convenience Write overloads into scope.

bool	Write (const char *s) noexcept
	Bring WriteOnly convenience Write overloads into scope.

bool	Write (const std::size_t &count, std::string_view sv) noexcept
	Bring WriteOnly convenience Write overloads into scope.

bool	Write (const std::size_t &count, const char *s) noexcept
	Bring WriteOnly convenience Write overloads into scope.

template<std::size_t N>
bool	Write (const char(&s)[N]) noexcept
	Bring WriteOnly convenience Write overloads into scope.

template<Type::ByteInputRange R>
bool	Write (const R &r) noexcept
	Bring WriteOnly convenience Write overloads into scope.

template<Type::ByteInputRange Rw>
bool	Write (const std::size_t &count, const Rw &r) noexcept
	Bring WriteOnly convenience Write overloads into scope.

template<Type::ByteInputRange Rrw>
bool	Write (const std::size_t &count, Rrw &&r) noexcept
	Bring WriteOnly convenience Write overloads into scope.

template<Type::ByteInputRange Rr>
bool	Write (Rr &&r) noexcept
	Bring WriteOnly convenience Write overloads into scope.

template<Type::ByteInputIterator I, typename S > requires Type::SentinelFor<S, I>
bool	Write (I first, S last) noexcept
	Bring WriteOnly convenience Write overloads into scope.

template<Type::ByteInputIterator I2, typename S2 > requires Type::SentinelFor<S2, I2>
bool	Write (const std::size_t &count, I2 first, S2 last) noexcept
	Bring WriteOnly convenience Write overloads into scope.

Public Member Functions inherited from StormByte::Buffer::ReadWrite
	ReadWrite () noexcept
	Default construct.

	ReadWrite (const ReadWrite &other) noexcept=default
	Copy construct.

	ReadWrite (ReadWrite &&other) noexcept=default
	Move construct.

virtual	~ReadWrite () noexcept
	Virtual destructor.

ReadWrite &	operator= (const ReadWrite &other)=default
	Copy assign.

ReadWrite &	operator= (ReadWrite &&other) noexcept=default
	Move assign.

Public Member Functions inherited from StormByte::Buffer::ReadOnly
	ReadOnly () noexcept
	Default construct.

	ReadOnly (const ReadOnly &) noexcept=default
	Copy construct.

	ReadOnly (ReadOnly &&) noexcept=default
	Move construct.

virtual	~ReadOnly () noexcept
	Virtual destructor.

ReadOnly &	operator= (const ReadOnly &)=default
	Copy assign.

ReadOnly &	operator= (ReadOnly &&) noexcept=default
	Move assign.

bool	Extract (DataType &outBuffer) noexcept
	Extract all available bytes into a DataType.

bool	Extract (WriteOnly &outBuffer) noexcept
	Extract all available bytes into a WriteOnly.

bool	Read (DataType &outBuffer) const noexcept
	Read all available bytes into a DataType.

bool	Read (WriteOnly &outBuffer) const noexcept
	Read all available bytes into a WriteOnly.

Public Member Functions inherited from StormByte::Buffer::Generic
	Generic () noexcept=default
	Default construct.

	Generic (const Generic &) noexcept=default
	Copy construct.

	Generic (Generic &&) noexcept=default
	Move construct.

virtual	~Generic () noexcept=0
	Pure virtual destructor (keeps the class abstract).

Generic &	operator= (const Generic &other)=default
	Copy assign.

Generic &	operator= (Generic &&) noexcept=default
	Move assign.

Public Member Functions inherited from StormByte::Buffer::WriteOnly
	WriteOnly () noexcept
	Default construct.

	WriteOnly (const WriteOnly &)=default
	Copy construct.

	WriteOnly (WriteOnly &&) noexcept=default
	Move construct.

virtual	~WriteOnly () noexcept
	Virtual destructor.

WriteOnly &	operator= (const WriteOnly &)=default
	Copy assign.

WriteOnly &	operator= (WriteOnly &&) noexcept=default
	Move assign.

bool	Write (const ReadOnly &data) noexcept
	Append all available bytes from a ReadOnly (copy).

bool	Write (ReadOnly &&data) noexcept
	Append all available bytes from a ReadOnly (move path).

bool	Write (std::string_view sv) noexcept
	Write a string view (no trailing NUL).

bool	Write (const char *s) noexcept
	Write a null-terminated C string.

bool	Write (const std::size_t &count, std::string_view sv) noexcept
	Write up to `count` characters from a string view.

bool	Write (const std::size_t &count, const char *s) noexcept
	Write up to `count` characters from a C string.

template<std::size_t N>
bool	Write (const char(&s)[N]) noexcept
	Write a string literal without the trailing NUL.

template<Type::ByteInputRange R>
bool	Write (const R &r) noexcept
	Write all elements from an input range.

template<Type::ByteInputRange Rw>
bool	Write (const std::size_t &count, const Rw &r) noexcept
	Write up to `count` elements from an input range.

template<Type::ByteInputRange Rrw>
bool	Write (const std::size_t &count, Rrw &&r) noexcept
	Write up to `count` elements from an rvalue range.

template<Type::ByteInputRange Rr>
bool	Write (Rr &&r) noexcept
	Write all elements from an rvalue range.

template<Type::ByteInputIterator I, typename S > requires Type::SentinelFor<S, I>
bool	Write (I first, S last) noexcept
	Write all elements from an iterator pair.

template<Type::ByteInputIterator I2, typename S2 > requires Type::SentinelFor<S2, I2>
bool	Write (const std::size_t &count, I2 first, S2 last) noexcept
	Write up to `count` elements from an iterator pair.

Protected Types
enum class	Operation { Extract , Read , Peek }
	Kind of internal read operation. More...

Protected Member Functions
std::size_t	AvailableBytesInternal () const noexcept
	Return unread bytes without virtual dispatch.

virtual std::ostringstream	HexDumpHeader () const noexcept
	Build the hexdump header (size / position / status).

Internal read / write helpers
virtual bool	ReadInternal (const std::size_t &count, DataType &outBuffer, const Operation &flag) noexcept
	Shared implementation for Extract / Read / Peek into DataType.

virtual bool	ReadInternal (const std::size_t &count, WriteOnly &outBuffer, const Operation &flag) noexcept
	Shared implementation for Extract / Read / Peek into WriteOnly.

virtual void	ReadUntilEoFInternal (DataType &outBuffer, const Operation &flag) noexcept
	Drain until EoF into DataType using `flag` semantics.

virtual void	ReadUntilEoFInternal (WriteOnly &outBuffer, const Operation &flag) noexcept
	Drain until EoF into WriteOnly using `flag` semantics.

virtual bool	WriteInternal (const std::size_t &count, const DataType &src) noexcept
	Append from DataType (copy).

virtual bool	WriteInternal (const std::size_t &count, DataType &&src) noexcept
	Append from DataType (move).

virtual bool	WriteInternal (const std::size_t &count, const ReadOnly &src) noexcept
	Append from ReadOnly (copy path).

virtual bool	WriteInternal (const std::size_t &count, ReadOnly &&src) noexcept
	Append from ReadOnly (move / extract path).

Static Protected Member Functions
static std::string	FormatHexLines (std::span< const std::byte > &data, std::size_t start_offset, std::size_t columns) noexcept
	Format hex/ASCII lines for a data span.

Static Protected Member Functions inherited from StormByte::Buffer::Generic
template<Type::ByteInputRange Src>
static DataType	DataConvert (const Src &src) noexcept
	Convert an lvalue input range to DataType.

template<Type::ByteInputRange Src>
static DataType	DataConvert (Src &&src) noexcept
	Convert an rvalue input range to DataType (moves when already DataType).

static DataType	DataConvert (std::string_view sv) noexcept
	Convert a string view to DataType (no trailing NUL).

static DataType	DataConvert (const char *s) noexcept
	Convert a null-terminated C string to DataType.

Protected Attributes
DataType	m_buffer
	Owned contiguous byte storage.

std::size_t	m_position_offset {0}
	Logical read offset from start of m_buffer.

bool	m_closed {false}
	Once true, further writes fail.

bool	m_error {false}
	Permanent error: unreadable and unwritable.

Detailed Description

Byte-oriented FIFO buffer with grow-on-demand and close/error support.

Overview: A contiguous growable buffer implemented atop DataType that tracks a logical read position. It grows automatically to fit writes and supports efficient non-destructive reads and destructive extracts.

Thread safety: This class is not thread-safe. For concurrent access use SharedFIFO or Ring.

Buffer behaviour: Supports clear / clean, a movable read position for non-destructive reads, and a closed / error state to signal end-of-writes or permanent failure. Once closed, further writes fail; readers can still drain remaining data until EoF().

See also: SharedFIFO, Ring, ReadWrite, Producer, Consumer

Member Enumeration Documentation

◆ Operation

enum class StormByte::Buffer::FIFO::Operation

strongprotected

Kind of internal read operation.

Enumerator
Extract	Destructive read.
Read	Non-destructive read (advances position)
Peek	Non-destructive peek (no advance)

Constructor & Destructor Documentation

◆ FIFO() [1/9]

StormByte::Buffer::FIFO::FIFO ( )

defaultnoexcept

Default construct an empty FIFO.

◆ FIFO() [2/9]

StormByte::Buffer::FIFO::FIFO ( const DataType & data )

inlinenoexcept

Construct FIFO with initial data (copy).

Parameters

data	Initial byte vector.

◆ FIFO() [3/9]

StormByte::Buffer::FIFO::FIFO ( DataType && data )

inlinenoexcept

Construct FIFO with initial data (move).

Parameters

data	Initial byte vector (moved into the FIFO).

◆ FIFO() [4/9]

template<Type::ByteInputRange R>
requires (!Type::SameAs<R, DataType>)

StormByte::Buffer::FIFO::FIFO ( const R & r )

inlinenoexcept

Construct FIFO from an input range (copy / convert).

Template Parameters

R	Input range whose elements are convertible to `std::byte`.

Parameters

r	Range to copy from.

Note: Disabled when R is already DataType to avoid overload ambiguity.

◆ FIFO() [5/9]

template<Type::ByteInputRange Rr>

StormByte::Buffer::FIFO::FIFO ( Rr && r )

inlinenoexcept

Construct FIFO from an rvalue range (moves when DataType).

Template Parameters

Rr	Input range type.

Parameters

r	Range to consume.

◆ FIFO() [6/9]

StormByte::Buffer::FIFO::FIFO ( std::string_view sv )

inlinenoexcept

Construct FIFO from a string view (no trailing NUL).

Parameters

sv	Source characters.

◆ FIFO() [7/9]

StormByte::Buffer::FIFO::FIFO ( const char * s )

inlinenoexcept

Construct FIFO from a null-terminated C string.

Parameters

s	Source string (may be null → empty buffer).

◆ FIFO() [8/9]

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

noexcept

Copy construct, preserving buffer contents and state.

Parameters

other Source FIFO.

◆ FIFO() [9/9]

StormByte::Buffer::FIFO::FIFO ( FIFO && other )

noexcept

Move construct.

Parameters

other Source FIFO (left empty / unspecified but valid).

◆ ~FIFO()

virtual StormByte::Buffer::FIFO::~FIFO ( )

virtualnoexcept

Virtual destructor.

Member Function Documentation

◆ AvailableBytes()

virtual std::size_t StormByte::Buffer::FIFO::AvailableBytes ( ) const

virtualnoexcept

Bytes available from the current read position.

Returns: Unread byte count.

See also: Size(), Read(), Extract(), Seek()

Implements StormByte::Buffer::ReadOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ AvailableBytesInternal()

std::size_t StormByte::Buffer::FIFO::AvailableBytesInternal ( ) const

protectednoexcept

Return unread bytes without virtual dispatch.

Returns: Number of bytes from the current read position.

Note: Callers that synchronize derived state must hold their own lock.

◆ Clean()

virtual void StormByte::Buffer::FIFO::Clean ( )

overridevirtualnoexcept

Discard data from the start up to the current read position.

Implements StormByte::Buffer::ReadOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ Clear()

virtual void StormByte::Buffer::FIFO::Clear ( )

overridevirtualnoexcept

Clear all buffer contents and reset the read position.

Does not clear the closed / error flags.

See also: Size(), Empty()

Implements StormByte::Buffer::ReadOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ Close()

void StormByte::Buffer::FIFO::Close ( )

overridevirtualnoexcept

Mark the buffer closed for further writes.

Subsequent Write() calls fail. Readers may still drain remaining data until AvailableBytes() is zero.

Implements StormByte::Buffer::WriteOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ Data()

virtual const DataType & StormByte::Buffer::FIFO::Data ( ) const

overridevirtualnoexcept

Access the internal storage.

Returns: Constant reference to the owned DataType.

Implements StormByte::Buffer::ReadOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ Drop()

virtual bool StormByte::Buffer::FIFO::Drop ( const std::size_t & count )

overridevirtualnoexcept

Discard count unread bytes and advance the read position.

Parameters

count Number of bytes to drop.

Returns: true on success, false if fewer bytes were available.

See also: Read(), Seek()

Implements StormByte::Buffer::ReadOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ Empty()

virtual bool StormByte::Buffer::FIFO::Empty ( ) const

overridevirtualnoexcept

Whether the underlying storage is empty.

Returns: true if m_buffer is empty.

Note: With a non-zero read position, Empty() may be false while AvailableBytes() is zero.

See also: Size(), AvailableBytes()

Implements StormByte::Buffer::ReadOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ EoF()

virtual bool StormByte::Buffer::FIFO::EoF ( ) const

overridevirtualnoexcept

End-of-stream condition.

Returns: true if in error, or closed with no remaining unread bytes.

Implements StormByte::Buffer::ReadOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ Extract() [1/6]

bool StormByte::Buffer::FIFO::Extract	(	const std::size_t &	count,
		DataType &	outBuffer
	)

overridevirtualnoexcept

Extract bytes into a DataType.

Parameters

count	Bytes to extract; 0 = all available.
outBuffer	Destination (filled / resized as needed).

Returns: true on success, false on failure.

Implements StormByte::Buffer::ReadOnly.

◆ Extract() [2/6]

virtual bool StormByte::Buffer::ReadOnly::Extract	(	const std::size_t &	count,
		DataType &	outBuffer
	)

inlinevirtualnoexcept

Bring ReadOnly convenience Extract overloads into scope.

Implements StormByte::Buffer::ReadOnly.

◆ Extract() [3/6]

bool StormByte::Buffer::FIFO::Extract	(	const std::size_t &	count,
		WriteOnly &	outBuffer
	)

overridevirtualnoexcept

Extract bytes into a WriteOnly.

Parameters

count	Bytes to extract; 0 = all available.
outBuffer	Destination writer.

Returns: true on success, false on failure.

Implements StormByte::Buffer::ReadOnly.

◆ Extract() [4/6]

virtual bool StormByte::Buffer::ReadOnly::Extract	(	const std::size_t &	count,
		WriteOnly &	outBuffer
	)

inlinevirtualnoexcept

Bring ReadOnly convenience Extract overloads into scope.

Implements StormByte::Buffer::ReadOnly.

◆ Extract() [5/6]

bool StormByte::Buffer::ReadOnly::Extract ( DataType & outBuffer )

inlinenoexcept

Bring ReadOnly convenience Extract overloads into scope.

◆ Extract() [6/6]

bool StormByte::Buffer::ReadOnly::Extract ( WriteOnly & outBuffer )

inlinenoexcept

Bring ReadOnly convenience Extract overloads into scope.

◆ ExtractUntilEoF() [1/2]

void StormByte::Buffer::FIFO::ExtractUntilEoF ( DataType & outBuffer )

overridevirtualnoexcept

Extract all remaining bytes until EoF into a DataType.

Parameters

outBuffer Destination buffer.

Implements StormByte::Buffer::ReadOnly.

◆ ExtractUntilEoF() [2/2]

void StormByte::Buffer::FIFO::ExtractUntilEoF ( WriteOnly & outBuffer )

overridevirtualnoexcept

Extract all remaining bytes until EoF into a WriteOnly.

Parameters

outBuffer Destination writer.

Implements StormByte::Buffer::ReadOnly.

◆ FormatHexLines()

static std::string StormByte::Buffer::FIFO::FormatHexLines	(	std::span< const std::byte > &	data,
		std::size_t	start_offset,
		std::size_t	columns
	)

staticprotectednoexcept

Format hex/ASCII lines for a data span.

Parameters

data	Bytes to dump.
start_offset	Display offset of the first byte.
columns	Bytes per line.

Returns: Formatted lines (no header).

◆ HexDump()

virtual std::string StormByte::Buffer::FIFO::HexDump	(	const std::size_t &	columns = `16`,
		const std::size_t &	byte_limit = `0`
	)		const

virtualnoexcept

Hexdump of unread contents from the current read position.

Parameters

columns	Bytes per line (0 → default 16).
byte_limit	Max bytes to include (0 → no limit).

Returns: Formatted string: size / position / status, then hex/ASCII lines (no trailing newline).

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ HexDumpHeader()

virtual std::ostringstream StormByte::Buffer::FIFO::HexDumpHeader ( ) const

protectedvirtualnoexcept

Build the hexdump header (size / position / status).

Returns: Stream containing the header lines.

◆ IsReadable()

virtual bool StormByte::Buffer::FIFO::IsReadable ( ) const

overridevirtualnoexcept

Whether the buffer can be read.

Returns: false in permanent error state.

Implements StormByte::Buffer::ReadOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ IsWritable()

virtual bool StormByte::Buffer::FIFO::IsWritable ( ) const

overridevirtualnoexcept

Whether the buffer accepts writes.

Returns: false if closed or in error.

Implements StormByte::Buffer::WriteOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ operator!=()

bool StormByte::Buffer::FIFO::operator!= ( const FIFO & other ) const

inlinenoexcept

Inequality comparison.

Parameters

other Other FIFO.

Returns: Negation of operator==.

◆ operator=() [1/2]

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

Copy assign, preserving buffer contents and state.

Parameters

other Source FIFO.

Returns: Reference to this FIFO.

◆ operator=() [2/2]

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

noexcept

Move assign.

Parameters

other Source FIFO.

Returns: Reference to this FIFO.

◆ operator==()

bool StormByte::Buffer::FIFO::operator== ( const FIFO & other ) const

inlinenoexcept

Equality comparison.

Parameters

other Other FIFO.

Returns: true if buffer contents, read position and closed/error flags match.

◆ Peek() [1/2]

bool StormByte::Buffer::FIFO::Peek	(	const std::size_t &	count,
		DataType &	outBuffer
	)		const

overridevirtualnoexcept

Peek into a DataType without advancing the read position.

Parameters

count	Bytes to peek; 0 = all available.
outBuffer	Destination buffer.

Returns: true on success, false on failure.

Implements StormByte::Buffer::ReadOnly.

◆ Peek() [2/2]

bool StormByte::Buffer::FIFO::Peek	(	const std::size_t &	count,
		WriteOnly &	outBuffer
	)		const

overridevirtualnoexcept

Peek into a WriteOnly without advancing the read position.

Parameters

count	Bytes to peek; 0 = all available.
outBuffer	Destination writer.

Returns: true on success, false on failure.

Implements StormByte::Buffer::ReadOnly.

◆ Read() [1/6]

bool StormByte::Buffer::FIFO::Read	(	const std::size_t &	count,
		DataType &	outBuffer
	)		const

overridevirtualnoexcept

Non-destructive read into a DataType (advances position).

Parameters

count	Bytes to read; 0 = all available.
outBuffer	Destination buffer.

Returns: true on success, false on failure.

Implements StormByte::Buffer::ReadOnly.

◆ Read() [2/6]

virtual bool StormByte::Buffer::ReadOnly::Read	(	const std::size_t &	count,
		DataType &	outBuffer
	)		const

virtualnoexcept

Bring ReadOnly convenience Read overloads into scope.

Implements StormByte::Buffer::ReadOnly.

◆ Read() [3/6]

bool StormByte::Buffer::FIFO::Read	(	const std::size_t &	count,
		WriteOnly &	outBuffer
	)		const

overridevirtualnoexcept

Non-destructive read into a WriteOnly (advances position).

Parameters

count	Bytes to read; 0 = all available.
outBuffer	Destination writer.

Returns: true on success, false on failure.

Implements StormByte::Buffer::ReadOnly.

◆ Read() [4/6]

virtual bool StormByte::Buffer::ReadOnly::Read	(	const std::size_t &	count,
		WriteOnly &	outBuffer
	)		const

virtualnoexcept

Bring ReadOnly convenience Read overloads into scope.

Implements StormByte::Buffer::ReadOnly.

◆ Read() [5/6]

bool StormByte::Buffer::ReadOnly::Read ( DataType & outBuffer ) const

inlinenoexcept

Bring ReadOnly convenience Read overloads into scope.

◆ Read() [6/6]

bool StormByte::Buffer::ReadOnly::Read ( WriteOnly & outBuffer ) const

inlinenoexcept

Bring ReadOnly convenience Read overloads into scope.

◆ ReadInternal() [1/2]

virtual bool StormByte::Buffer::FIFO::ReadInternal	(	const std::size_t &	count,
		DataType &	outBuffer,
		const Operation &	flag
	)

protectedvirtualnoexcept

Shared implementation for Extract / Read / Peek into DataType.

Parameters

count	Requested byte count (0 = all available).
outBuffer	Destination.
flag	Operation kind.

Returns: true on success.

◆ ReadInternal() [2/2]

virtual bool StormByte::Buffer::FIFO::ReadInternal	(	const std::size_t &	count,
		WriteOnly &	outBuffer,
		const Operation &	flag
	)

protectedvirtualnoexcept

Shared implementation for Extract / Read / Peek into WriteOnly.

Parameters

count	Requested byte count (0 = all available).
outBuffer	Destination writer.
flag	Operation kind.

Returns: true on success.

◆ ReadUntilEoF() [1/2]

void StormByte::Buffer::FIFO::ReadUntilEoF ( DataType & outBuffer ) const

overridevirtualnoexcept

Read all remaining bytes until EoF into a DataType.

Parameters

outBuffer Destination buffer.

Implements StormByte::Buffer::ReadOnly.

◆ ReadUntilEoF() [2/2]

void StormByte::Buffer::FIFO::ReadUntilEoF ( WriteOnly & outBuffer ) const

overridevirtualnoexcept

Read all remaining bytes until EoF into a WriteOnly.

Parameters

outBuffer Destination writer.

Implements StormByte::Buffer::ReadOnly.

◆ ReadUntilEoFInternal() [1/2]

virtual void StormByte::Buffer::FIFO::ReadUntilEoFInternal	(	DataType &	outBuffer,
		const Operation &	flag
	)

protectedvirtualnoexcept

Drain until EoF into DataType using flag semantics.

Parameters

outBuffer	Destination.
flag	Extract or Read.

◆ ReadUntilEoFInternal() [2/2]

virtual void StormByte::Buffer::FIFO::ReadUntilEoFInternal	(	WriteOnly &	outBuffer,
		const Operation &	flag
	)

protectedvirtualnoexcept

Drain until EoF into WriteOnly using flag semantics.

Parameters

outBuffer	Destination writer.
flag	Extract or Read.

◆ Seek()

virtual void StormByte::Buffer::FIFO::Seek	(	const std::ptrdiff_t &	offset,
		const Position &	mode
	)		const

overridevirtualnoexcept

Move the logical read position for non-destructive reads.

Parameters

offset	Offset value.
mode	Position::Absolute or Position::Relative.

Position is clamped to [0, Size()]. Does not modify stored data.

Implements StormByte::Buffer::ReadOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ SetError()

void StormByte::Buffer::FIFO::SetError ( )

overridevirtualnoexcept

Enter permanent error state (unreadable and unwritable).

Implements StormByte::Buffer::WriteOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ Size()

virtual std::size_t StormByte::Buffer::FIFO::Size ( ) const

overridevirtualnoexcept

Total number of bytes stored (including already-read prefix).

Returns: Size of the internal buffer.

See also: Empty(), AvailableBytes()

Implements StormByte::Buffer::ReadOnly.

Reimplemented in StormByte::Buffer::SharedFIFO.

◆ Write() [1/21]

bool StormByte::Buffer::WriteOnly::Write ( const char * s )

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [2/21]

template<std::size_t N>

bool StormByte::Buffer::WriteOnly::Write ( const char(&) s[N] )

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [3/21]

template<Type::ByteInputRange R>

bool StormByte::Buffer::WriteOnly::Write ( const R & r )

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [4/21]

bool StormByte::Buffer::WriteOnly::Write ( const ReadOnly & data )

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [5/21]

bool StormByte::Buffer::WriteOnly::Write	(	const std::size_t &	count,
		const char *	s
	)

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [6/21]

bool StormByte::Buffer::FIFO::Write	(	const std::size_t &	count,
		const DataType &	data
	)

overridevirtualnoexcept

Append bytes from a DataType (copy).

Parameters

count	Number of bytes to write.
data	Source vector.

Returns: true on success, false if closed / error.

Implements StormByte::Buffer::WriteOnly.

◆ Write() [7/21]

virtual bool StormByte::Buffer::WriteOnly::Write	(	const std::size_t &	count,
		const DataType &	data
	)

virtualnoexcept

Bring WriteOnly convenience Write overloads into scope.

Implements StormByte::Buffer::WriteOnly.

◆ Write() [8/21]

bool StormByte::Buffer::FIFO::Write	(	const std::size_t &	count,
		const ReadOnly &	data
	)

overridevirtualnoexcept

Append bytes from a ReadOnly source (copy).

Parameters

count	Number of bytes to write.
data	Source buffer.

Returns: true on success, false if closed / error.

Implements StormByte::Buffer::WriteOnly.

◆ Write() [9/21]

virtual bool StormByte::Buffer::WriteOnly::Write	(	const std::size_t &	count,
		const ReadOnly &	data
	)

virtualnoexcept

Bring WriteOnly convenience Write overloads into scope.

Implements StormByte::Buffer::WriteOnly.

◆ Write() [10/21]

template<Type::ByteInputRange Rw>

bool StormByte::Buffer::WriteOnly::Write	(	const std::size_t &	count,
		const Rw &	r
	)

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [11/21]

bool StormByte::Buffer::FIFO::Write	(	const std::size_t &	count,
		DataType &&	data
	)

overridevirtualnoexcept

Append bytes from a DataType (move).

Parameters

count	Number of bytes to write.
data	Source vector.

Returns: true on success, false if closed / error.

Implements StormByte::Buffer::WriteOnly.

◆ Write() [12/21]

virtual bool StormByte::Buffer::WriteOnly::Write	(	const std::size_t &	count,
		DataType &&	data
	)

virtualnoexcept

Bring WriteOnly convenience Write overloads into scope.

Implements StormByte::Buffer::WriteOnly.

◆ Write() [13/21]

template<Type::ByteInputIterator I2, typename S2 >
requires Type::SentinelFor<S2, I2>

bool StormByte::Buffer::WriteOnly::Write	(	const std::size_t &	count,
		I2	first,
		S2	last
	)

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [14/21]

bool StormByte::Buffer::FIFO::Write	(	const std::size_t &	count,
		ReadOnly &&	data
	)

overridevirtualnoexcept

Append bytes from a ReadOnly source (move / extract path).

Parameters

count	Number of bytes to write.
data	Source buffer.

Returns: true on success, false if closed / error.

Implements StormByte::Buffer::WriteOnly.

◆ Write() [15/21]

virtual bool StormByte::Buffer::WriteOnly::Write	(	const std::size_t &	count,
		ReadOnly &&	data
	)

virtualnoexcept

Bring WriteOnly convenience Write overloads into scope.

Implements StormByte::Buffer::WriteOnly.

◆ Write() [16/21]

template<Type::ByteInputRange Rrw>

bool StormByte::Buffer::WriteOnly::Write	(	const std::size_t &	count,
		Rrw &&	r
	)

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [17/21]

bool StormByte::Buffer::WriteOnly::Write	(	const std::size_t &	count,
		std::string_view	sv
	)

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [18/21]

template<Type::ByteInputIterator I, typename S >
requires Type::SentinelFor<S, I>

bool StormByte::Buffer::WriteOnly::Write	(	I	first,
		S	last
	)

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [19/21]

bool StormByte::Buffer::WriteOnly::Write ( ReadOnly && data )

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [20/21]

template<Type::ByteInputRange Rr>

bool StormByte::Buffer::WriteOnly::Write ( Rr && r )

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [21/21]

bool StormByte::Buffer::WriteOnly::Write ( std::string_view sv )

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ WriteInternal() [1/4]

virtual bool StormByte::Buffer::FIFO::WriteInternal	(	const std::size_t &	count,
		const DataType &	src
	)

protectedvirtualnoexcept

Append from DataType (copy).

Parameters

count	Number of bytes.
src	Source.

Returns: true on success, false if closed / error.

◆ WriteInternal() [2/4]

virtual bool StormByte::Buffer::FIFO::WriteInternal	(	const std::size_t &	count,
		const ReadOnly &	src
	)

protectedvirtualnoexcept

Append from ReadOnly (copy path).

Parameters

count	Number of bytes.
src	Source.

Returns: true on success, false if closed / error.

◆ WriteInternal() [3/4]

virtual bool StormByte::Buffer::FIFO::WriteInternal	(	const std::size_t &	count,
		DataType &&	src
	)

protectedvirtualnoexcept

Append from DataType (move).

Parameters

count	Number of bytes.
src	Source.

Returns: true on success, false if closed / error.

◆ WriteInternal() [4/4]

virtual bool StormByte::Buffer::FIFO::WriteInternal	(	const std::size_t &	count,
		ReadOnly &&	src
	)

protectedvirtualnoexcept

Append from ReadOnly (move / extract path).

Parameters

count	Number of bytes.
src	Source.

Returns: true on success, false if closed / error.

Member Data Documentation

◆ m_buffer

DataType StormByte::Buffer::FIFO::m_buffer

protected

Owned contiguous byte storage.

◆ m_closed

bool StormByte::Buffer::FIFO::m_closed {false}

protected

Once true, further writes fail.

◆ m_error

bool StormByte::Buffer::FIFO::m_error {false}

protected

Permanent error: unreadable and unwritable.

◆ m_position_offset

std::size_t StormByte::Buffer::FIFO::m_position_offset {0}

mutableprotected

Logical read offset from start of m_buffer.

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

lib/public/StormByte/buffer/fifo.hxx

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Operation

Constructor & Destructor Documentation

◆ FIFO() [1/9]

◆ FIFO() [2/9]

◆ FIFO() [3/9]

◆ FIFO() [4/9]

◆ FIFO() [5/9]

◆ FIFO() [6/9]

◆ FIFO() [7/9]

◆ FIFO() [8/9]

◆ FIFO() [9/9]

◆ ~FIFO()

Member Function Documentation

◆ AvailableBytes()

◆ AvailableBytesInternal()

◆ Clean()

◆ Clear()

◆ Close()

◆ Data()

◆ Drop()

◆ Empty()

◆ EoF()

◆ Extract() [1/6]

◆ Extract() [2/6]

◆ Extract() [3/6]

◆ Extract() [4/6]

◆ Extract() [5/6]

◆ Extract() [6/6]

◆ ExtractUntilEoF() [1/2]

◆ ExtractUntilEoF() [2/2]

◆ FormatHexLines()

◆ HexDump()

◆ HexDumpHeader()

◆ IsReadable()

◆ IsWritable()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Peek() [1/2]

◆ Peek() [2/2]

◆ Read() [1/6]

◆ Read() [2/6]

◆ Read() [3/6]

◆ Read() [4/6]

◆ Read() [5/6]

◆ Read() [6/6]

◆ ReadInternal() [1/2]

◆ ReadInternal() [2/2]

◆ ReadUntilEoF() [1/2]

◆ ReadUntilEoF() [2/2]

◆ ReadUntilEoFInternal() [1/2]

◆ ReadUntilEoFInternal() [2/2]

◆ Seek()

◆ SetError()

◆ Size()

◆ Write() [1/21]

◆ Write() [2/21]

◆ Write() [3/21]

◆ Write() [4/21]

◆ Write() [5/21]

◆ Write() [6/21]

◆ Write() [7/21]

◆ Write() [8/21]

◆ Write() [9/21]

◆ Write() [10/21]

◆ Write() [11/21]

◆ Write() [12/21]

◆ Write() [13/21]

◆ Write() [14/21]

◆ Write() [15/21]

◆ Write() [16/21]

◆ Write() [17/21]