High-performance, highly-concurrent thread-safe ring buffer. More...

#include <StormByte/buffer/ring.hxx>

Inheritance diagram for StormByte::Buffer::Ring:

[legend]

Collaboration diagram for StormByte::Buffer::Ring:

[legend]

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

	Ring (const StormByte::BinaryData &data) noexcept
	Construct with initial data (copy).

	Ring (StormByte::BinaryData &&data) noexcept
	Construct with initial data (move elements from StormByte::BinaryData).

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

template<Type::ByteInputRange Rr>
	Ring (Rr &&r) noexcept
	Construct from an rvalue range.

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

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

	Ring (const Ring &)=delete
	Copy constructor (deleted – mutexes are not copyable).

	Ring (Ring &&other) noexcept
	Move constructor.

virtual	~Ring () noexcept
	Virtual destructor.

Ring &	operator= (const Ring &)=delete
	Copy assignment (deleted).

Ring &	operator= (Ring &&other) noexcept
	Move assignment.

Comparison
bool	operator== (const Ring &other) const noexcept
	Equality comparison (contents and lifecycle state).

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

Queries
StormByte::ByteSize	Available () const noexcept override
	Bytes available from the current read position.

const StormByte::BinaryData &	Data () const noexcept override
	Snapshot of stored data (may rebuild an internal cache).

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

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

bool	HasError () const noexcept
	Whether SetError() has been called.

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

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

StormByte::ByteSize	Size () const noexcept override
	Total number of bytes stored.

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

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

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

bool	Drop (const StormByte::ByteSize &count) noexcept override
	Discard `count` unread bytes.

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).

Diagnostics
StormByte::String::String	HexDump (const StormByte::ByteSize &columns=16, const StormByte::ByteSize &byte_limit=0) const noexcept
	Hexdump of unread contents from the current read position.

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

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

Read (non-destructive, advances position)
bool	Read (const StormByte::ByteSize &count, StormByte::BinaryData &outBuffer) const noexcept override
	Non-destructive read into a StormByte::BinaryData (advances position).

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

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

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

Extract (destructive)
bool	Extract (const StormByte::ByteSize &count, StormByte::BinaryData &outBuffer) noexcept override
	Extract bytes into a StormByte::BinaryData.

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

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

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

Write
bool	Write (const StormByte::ByteSize &count, const StormByte::BinaryData &data) noexcept override
	Append bytes from a StormByte::BinaryData (copy).

bool	Write (const StormByte::ByteSize &count, StormByte::BinaryData &&data) noexcept override
	Append bytes from a StormByte::BinaryData (move).

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

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

virtual bool	Write (const StormByte::ByteSize &count, const BinaryData &data) noexcept=0
	Bring WriteOnly convenience Write overloads into scope.

virtual bool	Write (const StormByte::ByteSize &count, BinaryData &&data) noexcept=0
	Bring WriteOnly convenience Write overloads into scope.

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

virtual bool	Write (const StormByte::ByteSize &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 StormByte::ByteSize &count, std::string_view sv) noexcept
	Bring WriteOnly convenience Write overloads into scope.

bool	Write (const StormByte::ByteSize &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 StormByte::ByteSize &count, const Rw &r) noexcept
	Bring WriteOnly convenience Write overloads into scope.

template<Type::ByteInputRange Rrw>
bool	Write (const StormByte::ByteSize &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 StormByte::ByteSize &count, I2 first, S2 last) noexcept
	Bring WriteOnly convenience Write overloads into scope.

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

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

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

virtual	~ReadWrite () noexcept
	Destructor.

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

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

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

	ReadOnly (const ReadOnly &other) noexcept=default
	Copy constructor.

	ReadOnly (ReadOnly &&other) noexcept=default
	Move constructor.

virtual	~ReadOnly () noexcept
	Destructor.

ReadOnly &	operator= (const ReadOnly &other)=default
	Copy assignment.

ReadOnly &	operator= (ReadOnly &&other) noexcept=default
	Move assignment.

bool	Extract (StormByte::BinaryData &outBuffer) noexcept
	Extract all available bytes into a StormByte::BinaryData.

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

bool	Read (StormByte::BinaryData &outBuffer) const noexcept
	Read all available bytes into a StormByte::BinaryData.

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 constructor.

	Generic (const Generic &other) noexcept=default
	Copy constructor.

	Generic (Generic &&other) noexcept=default
	Move constructor.

virtual	~Generic () noexcept=0
	Pure virtual destructor.

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

Generic &	operator= (Generic &&other) noexcept=default
	Move assignment.

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

	WriteOnly (const WriteOnly &other)=default
	Copy constructor.

	WriteOnly (WriteOnly &&other) noexcept=default
	Move constructor.

virtual	~WriteOnly () noexcept
	Destructor.

WriteOnly &	operator= (const WriteOnly &other)=default
	Copy assignment.

WriteOnly &	operator= (WriteOnly &&other) noexcept=default
	Move assignment.

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 (extract).

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

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

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

bool	Write (const StormByte::ByteSize &count, const char *s) noexcept
	Write up to `count` characters of 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 StormByte::ByteSize &count, const Rw &r) noexcept
	Write up to `count` elements from an input range.

template<Type::ByteInputRange Rrw>
bool	Write (const StormByte::ByteSize &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 StormByte::ByteSize &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
virtual std::ostringstream	HexDumpHeader () const noexcept
	Build the hexdump header (size / position / status).

Internal helpers
virtual bool	ReadInternal (const StormByte::ByteSize &count, StormByte::BinaryData &outBuffer, Operation flag) noexcept
	Shared implementation for Extract / Read / Peek into StormByte::BinaryData.

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

virtual void	ReadUntilEoFInternal (StormByte::BinaryData &outBuffer, Operation flag) noexcept
	Drain until EoF into StormByte::BinaryData using `flag` semantics.

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

virtual bool	WriteInternal (const StormByte::ByteSize &count, const StormByte::BinaryData &src) noexcept
	Append from StormByte::BinaryData (copy).

virtual bool	WriteInternal (const StormByte::ByteSize &count, StormByte::BinaryData &&src) noexcept
	Append from StormByte::BinaryData (move).

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

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

template<Type::ByteInputRange Src>
static BinaryData	DataConvert (Src &&src) noexcept
	Convert an rvalue input range to StormByte::BinaryData.

static BinaryData	DataConvert (std::string_view sv) noexcept
	Convert a string view to StormByte::BinaryData.

static BinaryData	DataConvert (const char *s) noexcept
	Convert a C string to StormByte::BinaryData.

Detailed Description

High-performance, highly-concurrent thread-safe ring buffer.

Overview: Backed by std::deque<std::byte> with a logical read position. Uses std::shared_mutex so multiple readers can proceed concurrently while writers and destructive operations remain exclusive. Critical sections are kept as short as possible; blocked readers wait on a condition_variable_any.

Thread safety: Fully thread-safe for concurrent producers and consumers (many-to-many). Pipeline intermediates use a private SPSC ring; this type is the public many-to-many ring.

Lifecycle: Close() stops further writes; remaining data can still be drained. SetError() makes the buffer permanently unreadable and unwritable and wakes waiters.

See also: Producer, Consumer, ReadWrite, SharedFIFO

Member Enumeration Documentation

◆ Operation

enum class StormByte::Buffer::Ring::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

◆ Ring() [1/9]

StormByte::Buffer::Ring::Ring ( )

defaultnoexcept

Default construct an empty Ring.

◆ Ring() [2/9]

StormByte::Buffer::Ring::Ring ( const StormByte::BinaryData & data )

inlineexplicitnoexcept

Construct with initial data (copy).

Parameters

data	Source bytes.

◆ Ring() [3/9]

StormByte::Buffer::Ring::Ring ( StormByte::BinaryData && data )

inlineexplicitnoexcept

Construct with initial data (move elements from StormByte::BinaryData).

Parameters

data	Source bytes (moved element-wise into the deque).

◆ Ring() [4/9]

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

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

inlineexplicitnoexcept

Construct from an input range (copy / convert).

Template Parameters

R	Range whose value_type is convertible to `std::byte`.

Parameters

r	Source range (disabled when already StormByte::BinaryData).

◆ Ring() [5/9]

template<Type::ByteInputRange Rr>

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

inlineexplicitnoexcept

Construct from an rvalue range.

Template Parameters

Rr	Range type.

Parameters

r	Source range.

◆ Ring() [6/9]

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

inlineexplicitnoexcept

Construct from a string view (no trailing NUL).

Parameters

sv	Source characters.

◆ Ring() [7/9]

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

inlineexplicitnoexcept

Construct from a null-terminated C string.

Parameters

s	Source string (may be null → empty).

◆ Ring() [8/9]

StormByte::Buffer::Ring::Ring ( const Ring & )

delete

Copy constructor (deleted – mutexes are not copyable).

◆ Ring() [9/9]

StormByte::Buffer::Ring::Ring ( Ring && other )

noexcept

Move constructor.

Parameters

other Source Ring.

◆ ~Ring()

virtual StormByte::Buffer::Ring::~Ring ( )

virtualnoexcept

Virtual destructor.

Member Function Documentation

◆ Available()

StormByte::ByteSize StormByte::Buffer::Ring::Available ( ) const

overridevirtualnoexcept

Bytes available from the current read position.

Returns: Unread byte count.

Implements StormByte::Buffer::ReadOnly.

◆ Clean()

void StormByte::Buffer::Ring::Clean ( )

overridevirtualnoexcept

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

Implements StormByte::Buffer::ReadOnly.

◆ Clear()

void StormByte::Buffer::Ring::Clear ( )

overridevirtualnoexcept

Clear all contents and reset the read position.

Does not clear closed / error flags.

Implements StormByte::Buffer::ReadOnly.

◆ Close()

void StormByte::Buffer::Ring::Close ( )

overridevirtualnoexcept

Close the buffer for further writes.

Subsequent writes fail; readers may still drain data. Waiters are notified.

Implements StormByte::Buffer::WriteOnly.

◆ Data()

const StormByte::BinaryData & StormByte::Buffer::Ring::Data ( ) const

overridevirtualnoexcept

Snapshot of stored data (may rebuild an internal cache).

Returns: Constant reference to a StormByte::BinaryData view.

Implements StormByte::Buffer::ReadOnly.

◆ Drop()

bool StormByte::Buffer::Ring::Drop ( const StormByte::ByteSize & count )

overridevirtualnoexcept

Discard count unread bytes.

Parameters

count Number of bytes to drop.

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

Implements StormByte::Buffer::ReadOnly.

◆ Empty()

bool StormByte::Buffer::Ring::Empty ( ) const

overridevirtualnoexcept

Whether the underlying storage is empty.

Returns: true if empty.

Implements StormByte::Buffer::ReadOnly.

◆ EoF()

bool StormByte::Buffer::Ring::EoF ( ) const

overridevirtualnoexcept

End-of-stream condition.

Returns: true if closed (or in error) and no unread bytes remain.

Implements StormByte::Buffer::ReadOnly.

◆ Extract() [1/2]

bool StormByte::Buffer::Ring::Extract	(	const StormByte::ByteSize &	count,
		StormByte::BinaryData &	outBuffer
	)

overridevirtualnoexcept

Extract bytes into a StormByte::BinaryData.

Parameters

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

Returns: true on success, false on failure.

Implements StormByte::Buffer::ReadOnly.

◆ Extract() [2/2]

bool StormByte::Buffer::Ring::Extract	(	const StormByte::ByteSize &	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.

◆ ExtractUntilEoF() [1/2]

void StormByte::Buffer::Ring::ExtractUntilEoF ( StormByte::BinaryData & outBuffer )

overridevirtualnoexcept

Extract all remaining bytes until EoF into a StormByte::BinaryData.

Parameters

outBuffer Destination buffer.

Implements StormByte::Buffer::ReadOnly.

◆ ExtractUntilEoF() [2/2]

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

overridevirtualnoexcept

Extract all remaining bytes until EoF into a WriteOnly.

Parameters

outBuffer Destination writer.

Implements StormByte::Buffer::ReadOnly.

◆ FormatHexLines()

static StormByte::String::String StormByte::Buffer::Ring::FormatHexLines	(	std::span< const std::byte >	data,
		StormByte::ByteSize	start_offset,
		StormByte::ByteSize	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).

◆ HasError()

bool StormByte::Buffer::Ring::HasError ( ) const

noexcept

Whether SetError() has been called.

Returns: true in permanent error state.

◆ HexDump()

StormByte::String::String StormByte::Buffer::Ring::HexDump	(	const StormByte::ByteSize &	columns = `16`,
		const StormByte::ByteSize &	byte_limit = `0`
	)		const

noexcept

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 diagnostic string.

◆ HexDumpHeader()

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

protectedvirtualnoexcept

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

Returns: Stream containing the header lines.

◆ IsReadable()

bool StormByte::Buffer::Ring::IsReadable ( ) const

overridevirtualnoexcept

Whether the buffer can still be read.

Returns: false in permanent error state.

Implements StormByte::Buffer::ReadOnly.

◆ IsWritable()

bool StormByte::Buffer::Ring::IsWritable ( ) const

overridevirtualnoexcept

Whether the buffer accepts writes.

Returns: false if closed or in error.

Implements StormByte::Buffer::WriteOnly.

◆ operator!=()

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

inlinenoexcept

Inequality comparison.

Parameters

other Other Ring.

Returns: Negation of operator==.

◆ operator=() [1/2]

Ring & StormByte::Buffer::Ring::operator= ( const Ring & )

delete

Copy assignment (deleted).

◆ operator=() [2/2]

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

noexcept

Move assignment.

Parameters

other Source Ring.

Returns: Reference to this Ring.

◆ operator==()

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

noexcept

Equality comparison (contents and lifecycle state).

Parameters

other Other Ring.

Returns: true if equal under the comparison rules.

◆ Peek() [1/2]

bool StormByte::Buffer::Ring::Peek	(	const StormByte::ByteSize &	count,
		StormByte::BinaryData &	outBuffer
	)		const

overridevirtualnoexcept

Peek into a StormByte::BinaryData 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::Ring::Peek	(	const StormByte::ByteSize &	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/2]

bool StormByte::Buffer::Ring::Read	(	const StormByte::ByteSize &	count,
		StormByte::BinaryData &	outBuffer
	)		const

overridevirtualnoexcept

Non-destructive read into a StormByte::BinaryData (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/2]

bool StormByte::Buffer::Ring::Read	(	const StormByte::ByteSize &	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.

◆ ReadInternal() [1/2]

virtual bool StormByte::Buffer::Ring::ReadInternal	(	const StormByte::ByteSize &	count,
		StormByte::BinaryData &	outBuffer,
		Operation	flag
	)

protectedvirtualnoexcept

Shared implementation for Extract / Read / Peek into StormByte::BinaryData.

Parameters

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

Returns: true on success.

◆ ReadInternal() [2/2]

virtual bool StormByte::Buffer::Ring::ReadInternal	(	const StormByte::ByteSize &	count,
		WriteOnly &	outBuffer,
		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::Ring::ReadUntilEoF ( StormByte::BinaryData & outBuffer ) const

overridevirtualnoexcept

Read all remaining bytes until EoF into a StormByte::BinaryData.

Parameters

outBuffer Destination buffer.

Implements StormByte::Buffer::ReadOnly.

◆ ReadUntilEoF() [2/2]

void StormByte::Buffer::Ring::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::Ring::ReadUntilEoFInternal	(	StormByte::BinaryData &	outBuffer,
		Operation	flag
	)

protectedvirtualnoexcept

Drain until EoF into StormByte::BinaryData using flag semantics.

Parameters

outBuffer	Destination.
flag	Extract or Read.

◆ ReadUntilEoFInternal() [2/2]

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

protectedvirtualnoexcept

Drain until EoF into WriteOnly using flag semantics.

Parameters

outBuffer	Destination.
flag	Extract or Read.

◆ Seek()

void StormByte::Buffer::Ring::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.

Implements StormByte::Buffer::ReadOnly.

◆ SetError()

void StormByte::Buffer::Ring::SetError ( )

overridevirtualnoexcept

Enter permanent error state (unreadable and unwritable).

Waiters are notified.

Implements StormByte::Buffer::WriteOnly.

◆ Size()

StormByte::ByteSize StormByte::Buffer::Ring::Size ( ) const

overridevirtualnoexcept

Total number of bytes stored.

Returns: Size in bytes.

Implements StormByte::Buffer::Generic.

◆ 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]

virtual bool StormByte::Buffer::WriteOnly::Write	(	const StormByte::ByteSize &	count,
		BinaryData &&	data
	)

virtualnoexcept

Bring WriteOnly convenience Write overloads into scope.

Implements StormByte::Buffer::WriteOnly.

◆ Write() [6/21]

virtual bool StormByte::Buffer::WriteOnly::Write	(	const StormByte::ByteSize &	count,
		const BinaryData &	data
	)

virtualnoexcept

Bring WriteOnly convenience Write overloads into scope.

Implements StormByte::Buffer::WriteOnly.

◆ Write() [7/21]

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

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [8/21]

bool StormByte::Buffer::Ring::Write	(	const StormByte::ByteSize &	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 StormByte::ByteSize &	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 StormByte::ByteSize &	count,
		const Rw &	r
	)

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [11/21]

bool StormByte::Buffer::Ring::Write	(	const StormByte::ByteSize &	count,
		const StormByte::BinaryData &	data
	)

overridevirtualnoexcept

Append bytes from a StormByte::BinaryData (copy).

Parameters

count	Number of bytes to write.
data	Source.

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

Implements StormByte::Buffer::WriteOnly.

◆ Write() [12/21]

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

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

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [13/21]

bool StormByte::Buffer::Ring::Write	(	const StormByte::ByteSize &	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() [14/21]

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

virtualnoexcept

Bring WriteOnly convenience Write overloads into scope.

Implements StormByte::Buffer::WriteOnly.

◆ Write() [15/21]

template<Type::ByteInputRange Rrw>

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

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [16/21]

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

inlinenoexcept

Bring WriteOnly convenience Write overloads into scope.

◆ Write() [17/21]

bool StormByte::Buffer::Ring::Write	(	const StormByte::ByteSize &	count,
		StormByte::BinaryData &&	data
	)

overridevirtualnoexcept

Append bytes from a StormByte::BinaryData (move).

Parameters

count	Number of bytes to write.
data	Source.

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

Implements StormByte::Buffer::WriteOnly.

◆ 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/2]

virtual bool StormByte::Buffer::Ring::WriteInternal	(	const StormByte::ByteSize &	count,
		const StormByte::BinaryData &	src
	)

protectedvirtualnoexcept

Append from StormByte::BinaryData (copy).

Parameters

count	Number of bytes.
src	Source.

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

◆ WriteInternal() [2/2]

virtual bool StormByte::Buffer::Ring::WriteInternal	(	const StormByte::ByteSize &	count,
		StormByte::BinaryData &&	src
	)

protectedvirtualnoexcept

Append from StormByte::BinaryData (move).

Parameters

count	Number of bytes.
src	Source.

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

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

lib/public/StormByte/buffer/ring.hxx

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ Operation

Constructor & Destructor Documentation

◆ Ring() [1/9]

◆ Ring() [2/9]

◆ Ring() [3/9]

◆ Ring() [4/9]

◆ Ring() [5/9]

◆ Ring() [6/9]

◆ Ring() [7/9]

◆ Ring() [8/9]

◆ Ring() [9/9]

◆ ~Ring()

Member Function Documentation

◆ Available()

◆ Clean()

◆ Clear()

◆ Close()

◆ Data()

◆ Drop()

◆ Empty()

◆ EoF()

◆ Extract() [1/2]

◆ Extract() [2/2]

◆ ExtractUntilEoF() [1/2]

◆ ExtractUntilEoF() [2/2]

◆ FormatHexLines()

◆ HasError()

◆ HexDump()

◆ HexDumpHeader()

◆ IsReadable()

◆ IsWritable()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Peek() [1/2]

◆ Peek() [2/2]

◆ Read() [1/2]

◆ Read() [2/2]

◆ 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]

◆ Write() [18/21]

◆ Write() [19/21]

◆ Write() [20/21]

◆ Write() [21/21]

◆ WriteInternal() [1/2]

◆ WriteInternal() [2/2]