StormByte-Buffer 4.0.0
C++26 buffer module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Buffer::IO::BufferedLocationReader::Unpacked Struct Reference

Knobs after Parameters has been unpacked. More...

#include <StormByte/buffer/io/buffered_location_reader.hxx>

Collaboration diagram for StormByte::Buffer::IO::BufferedLocationReader::Unpacked:

Public Member Functions

STORMBYTE_FORCE_INLINE Unpacked (const Parameters &parameters, StormByte::ByteSize default_memory=StormByte::ByteSize{0})
 Unpack a bag in the caller.
 Unpacked (const Unpacked &other) noexcept=default
 Copy resolved knobs.
 Unpacked (Unpacked &&other) noexcept=default
 Move resolved knobs.
 ~Unpacked () noexcept=default
 Destroy non-owning knobs.
Unpacked & operator= (const Unpacked &other) noexcept=default
 Copy resolved knobs.
Unpacked & operator= (Unpacked &&other) noexcept=default
 Move resolved knobs.

Public Attributes

ReaderConfiguration m_configuration
 Complete resolved reader policy.
bool m_probe
 Probe the read window during Setup.

Detailed Description

Knobs after Parameters has been unpacked.

Trivial. This is what crosses the DLL. Parameters stays in the caller because it owns Safe::Optional.

Constructor & Destructor Documentation

◆ Unpacked() [1/3]

STORMBYTE_FORCE_INLINE StormByte::Buffer::IO::BufferedLocationReader::Unpacked::Unpacked ( const Parameters & parameters,
StormByte::ByteSize default_memory = StormByte::ByteSize{0} )
inline

Unpack a bag in the caller.

Parameters
parametersOmitted ReadAhead → probe. Omitted MaxWait → 0 ms.
default_memoryBudget when MaxMemory is omitted.
Note
Implicit conversion resolves Parameters in the caller before invoking the provider's nondelegating location constructor.

◆ Unpacked() [2/3]

StormByte::Buffer::IO::BufferedLocationReader::Unpacked::Unpacked ( const Unpacked & other)
defaultnoexcept

Copy resolved knobs.

Parameters
otherSource.

◆ Unpacked() [3/3]

StormByte::Buffer::IO::BufferedLocationReader::Unpacked::Unpacked ( Unpacked && other)
defaultnoexcept

Move resolved knobs.

Parameters
otherSource.

◆ ~Unpacked()

StormByte::Buffer::IO::BufferedLocationReader::Unpacked::~Unpacked ( )
defaultnoexcept

Destroy non-owning knobs.

Member Function Documentation

◆ operator=() [1/2]

Unpacked & StormByte::Buffer::IO::BufferedLocationReader::Unpacked::operator= ( const Unpacked & other)
defaultnoexcept

Copy resolved knobs.

Parameters
otherSource.
Returns
This value.

◆ operator=() [2/2]

Unpacked & StormByte::Buffer::IO::BufferedLocationReader::Unpacked::operator= ( Unpacked && other)
defaultnoexcept

Move resolved knobs.

Parameters
otherSource.
Returns
This value.

Member Data Documentation

◆ m_configuration

ReaderConfiguration StormByte::Buffer::IO::BufferedLocationReader::Unpacked::m_configuration

Complete resolved reader policy.

◆ m_probe

bool StormByte::Buffer::IO::BufferedLocationReader::Unpacked::m_probe

Probe the read window during Setup.


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