std::fmt

StructFormattingOptions

pub struct FormattingOptions {/* private fields */ }

🔬This is a nightly-only experimental API. (formatting_options #118117)

Expand description

Options for formatting.

FormattingOptions is aFormatter without an attachedWrite trait.It is mainly used to constructFormatter instances.

Implementations§

Source §

implFormattingOptions

Source

pub const fnnew() ->FormattingOptions

🔬This is a nightly-only experimental API. (formatting_options #118117)

Construct a newFormatterBuilder with the suppliedWrite traitobject for output that is equivalent to the{} formattingspecifier:

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

Source

pub const fnsign(&mut self, sign:Option<Sign>) -> &mutFormattingOptions

🔬This is a nightly-only experimental API. (formatting_options #118117)

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

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

Source

pub const fnsign_aware_zero_pad( &mut self, sign_aware_zero_pad:bool,) -> &mutFormattingOptions

🔬This is a nightly-only experimental API. (formatting_options #118117)

Sets or unsets the0 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

Source

pub const fnalternate(&mut self, alternate:bool) -> &mutFormattingOptions

🔬This is a nightly-only experimental API. (formatting_options #118117)

Sets or unsets the# flag.

This flag indicates that the “alternate” form of printing should beused. The alternate forms are:

Debug : pretty-print theDebug formatting (adds linebreaks and indentation)
LowerHex as well asUpperHex - precedes the argument with a0x
Octal - precedes the argument with a0o
Binary - precedes the argument with a0b

Source

pub const fnfill(&mut self, fill:char) -> &mutFormattingOptions

🔬This is a nightly-only experimental API. (formatting_options #118117)

Sets the fill character.

The optional fill character and alignment is provided normally inconjunction with the width parameter. This indicates that if the valuebeing formatted is smaller than width some extra characters will beprinted around it.

Source

pub const fnalign( &mut self, align:Option<Alignment>,) -> &mutFormattingOptions

🔬This is a nightly-only experimental API. (formatting_options #118117)

Sets or removes the alignment.

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

Source

pub const fnwidth(&mut self, width:Option<u16>) -> &mutFormattingOptions

🔬This is a nightly-only experimental API. (formatting_options #118117)

Sets or removes the width.

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

Source

pub const fnprecision( &mut self, precision:Option<u16>,) -> &mutFormattingOptions

🔬This is a nightly-only experimental API. (formatting_options #118117)

Sets or removes the precision.

For non-numeric types, this can be considered a “maximum width”. Ifthe resulting string is longer than this width, then it is truncateddown to this many characters and that truncated value is emitted withproper 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 thedecimal point should be printed.

Source