TFormat< TChar >::Bin Struct Reference

Description:

template<typename TChar>
struct alib::strings::TFormat< TChar >::Bin

---

Implements a temporary object which can be appended to instances of type AString .

Appends an integral value in binary format.

See also

Class TNumberFormat for more information on formatting options for binary number output.

Definition at line 271 of file format.hpp.

#include <format.hpp>

Public Field Index:
TNumberFormat< TChar > *	nf
uint64_t	theValue
	The value to write.
int	theWidth

Public Method Index:
template<typename TIntegral >
	Bin (TIntegral value, int overrideWidth=0, TNumberFormat< TChar > *numberFormat=nullptr)
template<typename TIntegral >
	Bin (TIntegral value, TNumberFormat< TChar > *numberFormat)

Field Details:

nf

template<typename TChar >

TNumberFormat<TChar>* nf

The number format to use. Defaults to nullptr which chooses NumberFormat::Computational .

Definition at line 279 of file format.hpp.

theValue

template<typename TChar >

uint64_t theValue

The value to write.

Definition at line 274 of file format.hpp.

theWidth

template<typename TChar >

int theWidth

The minimum width of the number to write. Defaults to 0 which denotes to choose the value of field NumberFormat::BinFieldWidth .

Definition at line 275 of file format.hpp.

Constructor(s) / Destructor Details::

Bin() [1/2]

template<typename TChar >

template<typename TIntegral >

Bin ( TIntegral value, int overrideWidth = 0, TNumberFormat< TChar > * numberFormat = nullptr )

inline

Constructor, taking the value and formatting parameters.

Template Parameters

TIntegral

Value type which has to be statically castable to std::uint64_t.

Parameters

value	The value to write.
overrideWidth	Defaults to 0 which denotes to choose the value of field NumberFormat::BinFieldWidth .
numberFormat	The number format to use. Defaults to nullptr which chooses the static singleton found in NumberFormat::Computational .

Definition at line 295 of file format.hpp.

Bin() [2/2]

template<typename TChar >

template<typename TIntegral >

Bin ( TIntegral value, TNumberFormat< TChar > * numberFormat )

inline

Constructor, taking the value and a just an object of type NumberFormat.

Template Parameters

TIntegral

Value type which has to be statically castable to std::uint64_t.

Parameters

value	The value to write.
numberFormat	The number format to use. Defaults to nullptr which chooses the static singleton found in NumberFormat::Computational .

Definition at line 312 of file format.hpp.

---

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

• format.hpp