fiber::FormatBool Struct Reference

formats a bool for use with OStream More...

#include <OStream.hpp>

Inheritance diagram for fiber::FormatBool:

Public Member Functions
constexpr	FormatBool (bool value)
constexpr FormatBool &	text ()
	enables formating to text (default)
constexpr FormatBool &	num ()
	disables formating to a numer
constexpr FormatBool &	left ()
	Aligns the number to the left.
constexpr FormatBool &	right ()
constexpr FormatBool &	center ()
constexpr FormatBool &	mwidth (int mw)
	Set a minimum width of characters that will be printed to the stream.
constexpr FormatBool &	fill (char c)
	Sets the fill character used for padding. Default is a space ' '.
Public Member Functions inherited from fiber::FormatBoolParam
constexpr	FormatBoolParam ()=default
constexpr	FormatBoolParam (const FormatBoolParam &)=default
constexpr FormatBoolParam &	operator= (const FormatBoolParam &)=default
constexpr	FormatBoolParam (const FormatStrParams &params)
constexpr FormatBoolParam &	operator= (const FormatStrParams &params)

Static Public Member Functions
static constexpr FormatBool	like (bool value, const FormatStrParams &params)
static constexpr FormatBool	like (bool value, const FormatBoolParam &params)

Public Attributes
bool	_value
Public Attributes inherited from fiber::FormatBoolParam
bool	_to_text = true
Public Attributes inherited from fiber::FormatStrParams
AlignmentLRC	_alignment = AlignmentLRC::Right
int	_mwidth = 0
char	_fill = ' '

Detailed Description

formats a bool for use with OStream

Constructor & Destructor Documentation

FormatBool()

fiber::FormatBool::FormatBool ( bool value )

inlineconstexpr

Member Function Documentation

center()

FormatBool & fiber::FormatBool::center ( )

inlineconstexpr

fill()

FormatBool & fiber::FormatBool::fill ( char c )

inlineconstexpr

Sets the fill character used for padding. Default is a space ' '.

left()

FormatBool & fiber::FormatBool::left ( )

inlineconstexpr

Aligns the number to the left.

Example:

stream << "'" << FormatBool(true).mwidth(6).left() << "', Expected: 'true  '" << newl;
stream << "'" << FormatBool(false).mwidth(6).left() << "', Expected: 'false '" << newl;

like() [1/2]

static constexpr FormatBool fiber::FormatBool::like ( bool value, const FormatBoolParam & params )

inlinestaticconstexpr

like() [2/2]

static constexpr FormatBool fiber::FormatBool::like ( bool value, const FormatStrParams & params )

inlinestaticconstexpr

mwidth()

FormatBool & fiber::FormatBool::mwidth ( int mw )

inlineconstexpr

Set a minimum width of characters that will be printed to the stream.

Example:

stream << '"' << FormatBool(true) << '"' << endl;                    // Outputs: "true"
stream << '"' << FormatBool(true).mwidth(6) << '"' << endl;          // Outputs: "  true"
stream << '"' << FormatBool(true).left().mwidth(6) << '"' << endl;   // Outputs: "true  "

num()

FormatBool & fiber::FormatBool::num ( )

inlineconstexpr

disables formating to a numer

prints the bool as numbers: '1', '0'

right()

FormatBool & fiber::FormatBool::right ( )

inlineconstexpr

text()

FormatBool & fiber::FormatBool::text ( )

inlineconstexpr

enables formating to text (default)

prints the bool as text: "true"/"false" (default if not calling the function)

Member Data Documentation

_value

bool fiber::FormatBool::_value

---

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

• fiber/OStream/OStream.hpp