Used by fmt to determine how to format the output of an fmt command. See the documentation fo bsl::fmt for more information. More...

#include <fmt_options.hpp>

Public Member Functions
constexpr	fmt_options (cstr_type const f) noexcept
	Creates a bsl::fmt_options given a user provided format string. The goal of this class is to pre-process as much of the format string that the compiler will allow so that at run-time, the program only has to parse this struct to determine how to format a specific argument. More...

constexpr char_type	fill () const noexcept
	Returns the "fill" field in the {fmt} syntax based on the previously provided format string. More...

constexpr void	set_fill (char_type const val) noexcept
	Sets the "fill" field in the {fmt} syntax, overriding what the previously provided format string provided. More...

constexpr fmt_align	align () const noexcept
	Returns the "align" field in the {fmt} syntax based on the previously provided format string. More...

constexpr void	set_align (fmt_align const val) noexcept
	Sets the "align" field in the {fmt} syntax, overriding what the previously provided format string provided. More...

constexpr fmt_sign	sign () const noexcept
	Returns the "sign" field in the {fmt} syntax based on the previously provided format string. More...

constexpr void	set_sign (fmt_sign const val) noexcept
	Sets the "sign" field in the {fmt} syntax, overriding what the previously provided format string provided. More...

constexpr bool	alternate_form () const noexcept
	Returns the "alt form" field in the {fmt} syntax based on the previously provided format string. More...

constexpr void	set_alternate_form (bool const val) noexcept
	Sets the "alt form" field in the {fmt} syntax, overriding what the previously provided format string provided. More...

constexpr bool	sign_aware () const noexcept
	Returns the "sign aware" field in the {fmt} syntax based on the previously provided format string. More...

constexpr void	set_sign_aware (bool const val) noexcept
	Sets the "sign aware" field in the {fmt} syntax, overriding what the previously provided format string provided. More...

constexpr bsl::uintmax	width () const noexcept
	Returns the "width" field in the {fmt} syntax based on the previously provided format string. More...

constexpr void	set_width (bsl::uintmax const val) noexcept
	Sets the "width" field in the {fmt} syntax, overriding what the previously provided format string provided. More...

constexpr fmt_type	type () const noexcept
	Returns the "type" field in the {fmt} syntax based on the previously provided format string. More...

constexpr void	set_type (fmt_type const val) noexcept
	Sets the "type" field in the {fmt} syntax, overriding what the previously provided format string provided. More...

Detailed Description

Used by fmt to determine how to format the output of an fmt command. See the documentation fo bsl::fmt for more information.

Constructor & Destructor Documentation

◆ fmt_options()

constexpr bsl::fmt_options::fmt_options ( cstr_type const f )

inlinenoexcept

Creates a bsl::fmt_options given a user provided format string. The goal of this class is to pre-process as much of the format string that the compiler will allow so that at run-time, the program only has to parse this struct to determine how to format a specific argument.

Parameters

f	the user provided format string.

Member Function Documentation

◆ fill()

bsl::fmt_options::fill ( ) const

inlinenoexcept

Returns the "fill" field in the {fmt} syntax based on the previously provided format string.

Returns: Returns the "fill" field in the {fmt} syntax based on the previously provided format string.

defines

◆ set_fill()

constexpr void bsl::fmt_options::set_fill ( char_type const val )

inlinenoexcept

Sets the "fill" field in the {fmt} syntax, overriding what the previously provided format string provided.

Parameters

val	the val to set the "fill" field to

◆ align()

bsl::fmt_options::align ( ) const

inlinenoexcept

Returns the "align" field in the {fmt} syntax based on the previously provided format string.

Returns: Returns the "align" field in the {fmt} syntax based on the previously provided format string.

defines the "align" field in the {fmt} syntax

◆ set_align()

constexpr void bsl::fmt_options::set_align ( fmt_align const val )

inlinenoexcept

Sets the "align" field in the {fmt} syntax, overriding what the previously provided format string provided.

Parameters

val	the val to set the "align" field to

◆ sign()

bsl::fmt_options::sign ( ) const

inlinenoexcept

Returns the "sign" field in the {fmt} syntax based on the previously provided format string.

Returns: Returns the "sign" field in the {fmt} syntax based on the previously provided format string.

defines the "sign" field in the {fmt} syntax

◆ set_sign()

constexpr void bsl::fmt_options::set_sign ( fmt_sign const val )

inlinenoexcept

Sets the "sign" field in the {fmt} syntax, overriding what the previously provided format string provided.

Parameters

val	the val to set the "sign" field to

◆ alternate_form()

bsl::fmt_options::alternate_form ( ) const

inlinenoexcept

Returns the "alt form" field in the {fmt} syntax based on the previously provided format string.

Returns: Returns the "alt form" field in the {fmt} syntax based on the previously provided format string.

defines the "#" field in the {fmt} syntax

◆ set_alternate_form()

constexpr void bsl::fmt_options::set_alternate_form ( bool const val )

inlinenoexcept

Sets the "alt form" field in the {fmt} syntax, overriding what the previously provided format string provided.

Parameters

val	the val to set the "alt form" field to

◆ sign_aware()

bsl::fmt_options::sign_aware ( ) const

inlinenoexcept

Returns the "sign aware" field in the {fmt} syntax based on the previously provided format string.

Returns: Returns the "sign aware" field in the {fmt} syntax based on the previously provided format string.

defines the "0" field in the {fmt} syntax

◆ set_sign_aware()

constexpr void bsl::fmt_options::set_sign_aware ( bool const val )

inlinenoexcept

Sets the "sign aware" field in the {fmt} syntax, overriding what the previously provided format string provided.

Parameters

val	the val to set the "sign aware" field to

◆ width()

bsl::fmt_options::width ( ) const

inlinenoexcept

Returns the "width" field in the {fmt} syntax based on the previously provided format string.

Returns: Returns the "width" field in the {fmt} syntax based on the previously provided format string.

defines the "width" field in the {fmt} syntax

◆ set_width()

constexpr void bsl::fmt_options::set_width ( bsl::uintmax const val )

inlinenoexcept

Sets the "width" field in the {fmt} syntax, overriding what the previously provided format string provided.

Parameters

val	the val to set the "width" field to

◆ type()

bsl::fmt_options::type ( ) const

inlinenoexcept

Returns the "type" field in the {fmt} syntax based on the previously provided format string.

Returns: Returns the "type" field in the {fmt} syntax based on the previously provided format string.

defines the "type" field in the {fmt} syntax

◆ set_type()

constexpr void bsl::fmt_options::set_type ( fmt_type const val )

inlinenoexcept

Sets the "type" field in the {fmt} syntax, overriding what the previously provided format string provided.

Parameters

val	the val to set the "type" field to

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

include/bsl/fmt_options.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ fmt_options()

Member Function Documentation

◆ fill()

◆ set_fill()

◆ align()

◆ set_align()

◆ sign()

◆ set_sign()

◆ alternate_form()

◆ set_alternate_form()

◆ sign_aware()

◆ set_sign_aware()

◆ width()

◆ set_width()

◆ type()

◆ set_type()