rpnx::compression::span_output_iterator Class Reference

Classes
class	assignment_proxy

Public Types
using	difference_type = std::ptrdiff_t
using	iterator_category = std::output_iterator_tag

Public Member Functions
	span_output_iterator (std::span< std::byte > output, format stream_format) noexcept
assignment_proxy	operator* () noexcept
span_output_iterator &	operator++ () noexcept
span_output_iterator	operator++ (int) noexcept
std::size_t	size () const noexcept

Detailed Description

Output iterator that bounds writes to caller-owned span storage.

Member Typedef Documentation

difference_type

using rpnx::compression::span_output_iterator::difference_type = std::ptrdiff_t

iterator_category

using rpnx::compression::span_output_iterator::iterator_category = std::output_iterator_tag

Constructor & Destructor Documentation

span_output_iterator()

rpnx::compression::span_output_iterator::span_output_iterator ( std::span< std::byte > output, format stream_format )

inlinenoexcept

Construct a bounded output iterator for one format.

Member Function Documentation

operator*()

assignment_proxy rpnx::compression::span_output_iterator::operator* ( )

inlinenodiscardnoexcept

Return a proxy for the current output position.

operator++() [1/2]

span_output_iterator & rpnx::compression::span_output_iterator::operator++ ( )

inlinenoexcept

Advance after an assignment.

operator++() [2/2]

span_output_iterator rpnx::compression::span_output_iterator::operator++ ( int )

inlinenoexcept

Advance after an assignment and return the prior iterator value.

size()

std::size_t rpnx::compression::span_output_iterator::size ( ) const

inlinenodiscardnoexcept

Return the number of bytes written.

---

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

• src/compression.cpp