StormByte-Buffer 4.0.0
C++26 buffer module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Buffer::IO::BufferedFileWriter::Parameters Class Reference

File-writer knobs. More...

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

Inheritance diagram for StormByte::Buffer::IO::BufferedFileWriter::Parameters:
Collaboration diagram for StormByte::Buffer::IO::BufferedFileWriter::Parameters:

Public Member Functions

 Parameters ()
 Construct an empty Safe-owned parameter bag.
template<typename... Knobs>
 Parameters (Knobs... knobs)
 Store writer knobs in Safe-owned optional values.
 Parameters (const Parameters &other)=default
 Copy Safe-owned knobs; may allocate and throw.
 Parameters (Parameters &&other) noexcept=default
 Transfer Safe-owned knobs.
 ~Parameters () noexcept=default
 Release knobs through provider callbacks.
Parameters & operator= (const Parameters &other)=default
 Copy Safe-owned knobs; may allocate and throw.
Parameters & operator= (Parameters &&other) noexcept=default
 Transfer Safe-owned knobs.
Public Member Functions inherited from StormByte::Buffer::IO::BufferedLocationWriter::Parameters
 Parameters ()=default
 Construct an empty Safe-owned parameter bag.
template<typename... Knobs>
 Parameters (Knobs... knobs)
 Store writer knobs in Safe-owned optional values.
 Parameters (const Parameters &other)=default
 Copy Safe-owned knobs; may allocate and throw.
 Parameters (Parameters &&other) noexcept=default
 Transfer Safe-owned knobs.
 ~Parameters () noexcept=default
 Release knobs through provider callbacks.
Parameters & operator= (const Parameters &other)=default
 Copy Safe-owned knobs; may allocate and throw.
Parameters & operator= (Parameters &&other) noexcept=default
 Transfer Safe-owned knobs.
Public Member Functions inherited from StormByte::Buffer::IO::BufferedWriter::Parameters
 Parameters ()=default
 Construct an empty Safe-owned parameter bag.
template<typename... Knobs>
 Parameters (Knobs... knobs)
 Store writer knobs in Safe-owned optional values.
 Parameters (const Parameters &other)=default
 Copy Safe-owned knobs; may allocate and throw.
 Parameters (Parameters &&other) noexcept=default
 Transfer Safe-owned knobs.
 ~Parameters () noexcept=default
 Release knobs through provider callbacks.
Parameters & operator= (const Parameters &other)=default
 Copy Safe-owned knobs; may allocate and throw.
Parameters & operator= (Parameters &&other) noexcept=default
 Transfer Safe-owned knobs.
Public Member Functions inherited from StormByte::Buffer::IO::WriterParameters
 WriterParameters ()=default
 No knobs.
template<typename... Knobs>
 WriterParameters (Knobs... knobs)
 Engage the listed knobs.
 WriterParameters (const WriterParameters &other)=default
 Copy Safe-owned optional knobs; may allocate and throw.
 WriterParameters (WriterParameters &&other) noexcept=default
 Transfer Safe-owned optional knobs.
 ~WriterParameters () noexcept=default
 Release optional knobs through provider callbacks.
WriterParameters & operator= (const WriterParameters &other)=default
 Copy Safe-owned optional knobs; may allocate and throw.
WriterParameters & operator= (WriterParameters &&other) noexcept=default
 Transfer Safe-owned optional knobs.
const StormByte::Safe::Optional< StormByte::ByteSize > & WriteTransfer () const noexcept
 Universal push maximum when the caller supplied it.
const StormByte::Safe::Optional< StormByte::ByteSize > & WriteThreshold () const noexcept
 Page-drain watermark when the caller supplied it.
const StormByte::Safe::Optional< StormByte::ByteSize > & WriteChunk () const noexcept
 Chunk size when the caller set it.
const StormByte::Safe::Optional< std::size_t > & BackPressure () const noexcept
 Backpressure when the caller set it.
const StormByte::Safe::Optional< StormByte::ByteSize > & MaxMemory () const noexcept
 Dirty-page budget when the caller set it.
const StormByte::Safe::Optional< std::chrono::milliseconds::rep > & MaxWait () const noexcept
 Signed millisecond count when the caller set the wait cap.

Detailed Description

File-writer knobs.

Same fields as BufferedLocationWriter::Parameters.

Note
Construction and copying may allocate and throw.

Constructor & Destructor Documentation

◆ Parameters() [1/4]

StormByte::Buffer::IO::BufferedFileWriter::Parameters::Parameters ( )
inline

Construct an empty Safe-owned parameter bag.

Note
Not noexcept: a bag may allocate while it is being filled.

◆ Parameters() [2/4]

template<typename... Knobs>
StormByte::Buffer::IO::BufferedFileWriter::Parameters::Parameters ( Knobs... knobs)
inline

Store writer knobs in Safe-owned optional values.

Template Parameters
KnobsSupported writer knobs.
Parameters
knobsValues to store.

◆ Parameters() [3/4]

StormByte::Buffer::IO::BufferedFileWriter::Parameters::Parameters ( const Parameters & other)
default

Copy Safe-owned knobs; may allocate and throw.

Parameters
otherSource bag.

◆ Parameters() [4/4]

StormByte::Buffer::IO::BufferedFileWriter::Parameters::Parameters ( Parameters && other)
defaultnoexcept

Transfer Safe-owned knobs.

Parameters
otherSource bag.

◆ ~Parameters()

StormByte::Buffer::IO::BufferedFileWriter::Parameters::~Parameters ( )
defaultnoexcept

Release knobs through provider callbacks.

Member Function Documentation

◆ operator=() [1/2]

Parameters & StormByte::Buffer::IO::BufferedFileWriter::Parameters::operator= ( const Parameters & other)
default

Copy Safe-owned knobs; may allocate and throw.

Parameters
otherSource bag.
Returns
This bag.

◆ operator=() [2/2]

Parameters & StormByte::Buffer::IO::BufferedFileWriter::Parameters::operator= ( Parameters && other)
defaultnoexcept

Transfer Safe-owned knobs.

Parameters
otherSource bag.
Returns
This bag.

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