Struct FormattingOptions

impl FormattingOptions

const fn new() -> Self

Construct a new FormattingOptions representing the plain {} formatting specifier:

• no flags,
• filled with spaces,
• no alignment,
• no width,
• no precision, and
• no DebugAsHex output mode.

const fn sign(&mut self, sign: Option<Sign>) -> &mut Self

Sets or removes the sign (the + or the - flag).

• +: This is intended for numeric types and indicates that the sign should always be printed. By default only the negative sign of signed values is printed, and the sign of positive or unsigned values is omitted. This flag indicates that the correct sign (+ or -) should always be printed.
• -: Currently not used

const fn sign_aware_zero_pad(&mut self, sign_aware_zero_pad: bool) -> &mut Self

Sets or unsets the 0 flag.

This is used to indicate for integer formats that the padding to width should both be done with a 0 character as well as be sign-aware

const fn alternate(&mut self, alternate: bool) -> &mut Self

Sets or unsets the # flag.

This flag indicates that the "alternate" form of printing should be used. The alternate forms are:

• Debug : pretty-print the Debug formatting (adds linebreaks and indentation)
• LowerHex as well as UpperHex - precedes the argument with a 0x
• Octal - precedes the argument with a 0o
• Binary - precedes the argument with a 0b

const fn fill(&mut self, fill: char) -> &mut Self

Sets the fill character.

The optional fill character and alignment is provided normally in conjunction with the width parameter. This indicates that if the value being formatted is smaller than width some extra characters will be printed around it.

const fn align(&mut self, align: Option<Alignment>) -> &mut Self

Sets or removes the alignment.

The alignment specifies how the value being formatted should be positioned if it is smaller than the width of the formatter.

const fn width(&mut self, width: Option<u16>) -> &mut Self

Sets or removes the width.

This is a parameter for the “minimum width” that the format should take up. If the value’s string does not fill up this many characters, then the padding specified by FormattingOptions::fill/FormattingOptions::align will be used to take up the required space.

const fn precision(&mut self, precision: Option<u16>) -> &mut Self

Sets or removes the precision.

• For non-numeric types, this can be considered a “maximum width”. If the resulting string is longer than this width, then it is truncated down to this many characters and that truncated value is emitted with proper fill, alignment and width if those parameters are set.
• For integral types, this is ignored.
• For floating-point types, this indicates how many digits after the decimal point should be printed.

const fn debug_as_hex(&mut self, debug_as_hex: Option<DebugAsHex>) -> &mut Self

Specifies whether the Debug trait should use lower-/upper-case hexadecimal or normal integers

const fn get_sign(&self) -> Option<Sign>

Returns the current sign (the + or the - flag).

const fn get_sign_aware_zero_pad(&self) -> bool

Returns the current 0 flag.

const fn get_alternate(&self) -> bool

Returns the current # flag.

const fn get_fill(&self) -> char

Returns the current fill character.

const fn get_align(&self) -> Option<Alignment>

Returns the current alignment.

const fn get_width(&self) -> Option<u16>

Returns the current width.

const fn get_precision(&self) -> Option<u16>

Returns the current precision.

const fn get_debug_as_hex(&self) -> Option<DebugAsHex>

Returns the current x? or X? flag.

const fn create_formatter<'a>(self, write: &'a mut dyn Write + 'a) -> Formatter<'a>

Creates a Formatter that writes its output to the given Write trait.

You may alternatively use [Formatter::new()].