binary_io::span_ostream class final

A stream which composes a non-owning view over a contiguous block of memory.

Base classes

template<class T>
class span_stream_base<std::byte>
Implements the common interface of every span_stream.
template<class Derived>
class ostream_interface<span_ostream>
A CRTP utility which can be used to flesh out the interface of a given stream.

Buffer management

auto rdbuf() noexcept -> std::span< std::byte >
Provides mutable access to the underlying buffer.
auto rdbuf() const noexcept -> std::span< const std::byte >
Provides immutable access to the underlying buffer.

Formatting

auto endian() const -> std::endian noexcept
Gets the current default endian format.
void endian(std::endian a_endian) noexcept
Sets the default endian format.

Position

void seek_absolute(binary_io::streamoff a_pos) noexcept
Seek to an absolute position in the stream (i.e. from the beginning).
void seek_relative(binary_io::streamoff a_off) noexcept
Seek to a position in the stream relative to the current position.
auto tell() const -> binary_io::streamoff noexcept
Gets the current stream position.

Writing

void write(Args... a_args)
Writes the given values into the output stream.
void write(std::endian a_endian, Args... a_args)
Writes the given values into the output stream, with the given endian format.
void write_bytes(std::span<const std::byte> a_src)
Writes bytes into the given buffer.

Function documentation

void binary_io::span_ostream::write_bytes(std::span<const std::byte> a_src)

Writes bytes into the given buffer.

Parameters
a_src The buffer to write bytes from.
Exceptions
binary_io::buffer_exhausted Thrown when the buffer has less than the requested number of bytes.