microfmt
Zero-allocation C++ formatting for constrained environments
Loading...
Searching...
No Matches
Public Member Functions | List of all members
microfmt::prefix_sink Class Reference

#include <styled_sink.hpp>

Public Member Functions

constexpr prefix_sink (sink target RELOCO_LIFETIME_CAPTURE_BY_THIS, microfmt::string_view prefix RELOCO_LIFETIME_CAPTURE_BY_THIS=" ") noexcept
 
 prefix_sink (const prefix_sink &)=delete
 
prefix_sink & operator= (const prefix_sink &)=delete
 
 prefix_sink (prefix_sink &&) noexcept=default
 
prefix_sink & operator= (prefix_sink &&) noexcept=default
 
sink as_sink () &noexcept RELOCO_LIFETIMEBOUND
 
void set_prefix (microfmt::string_view p RELOCO_LIFETIME_CAPTURE_BY_THIS) noexcept
 
void put (char c) noexcept
 
void write (microfmt::string_view sv) noexcept
 

Detailed Description

A sink adapter that writes a prefix at the start of each output line.

The configured prefix is emitted lazily, before the first character of a line. This preserves line state when formatting is split across multiple calls.

Constructor & Destructor Documentation

◆ prefix_sink() [1/3]

constexpr microfmt::prefix_sink::prefix_sink ( sink target  RELOCO_LIFETIME_CAPTURE_BY_THIS,
microfmt::string_view prefix  RELOCO_LIFETIME_CAPTURE_BY_THIS = "  " 
)
inlineexplicitconstexprnoexcept

Create a line-prefix adapter that forwards to target.

◆ prefix_sink() [2/3]

microfmt::prefix_sink::prefix_sink ( const prefix_sink &  )
delete

◆ prefix_sink() [3/3]

microfmt::prefix_sink::prefix_sink ( prefix_sink &&  )
defaultnoexcept

Member Function Documentation

◆ as_sink()

sink microfmt::prefix_sink::as_sink ( ) &
inlinenoexcept

Return a type-erased sink suitable for format_to.

◆ operator=() [1/2]

prefix_sink & microfmt::prefix_sink::operator= ( const prefix_sink &  )
delete

◆ operator=() [2/2]

prefix_sink & microfmt::prefix_sink::operator= ( prefix_sink &&  )
defaultnoexcept

◆ put()

void microfmt::prefix_sink::put ( char  c)
inlinenoexcept

◆ set_prefix()

void microfmt::prefix_sink::set_prefix ( microfmt::string_view p  RELOCO_LIFETIME_CAPTURE_BY_THIS)
inlinenoexcept

Change the prefix used for subsequent lines.

◆ write()

void microfmt::prefix_sink::write ( microfmt::string_view  sv)
inlinenoexcept

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