Struct FormatSpec

Source
pub struct FormatSpec {
    pub fill: Option<char>,
    pub align: Option<Align>,
    pub sign: Option<Sign>,
    pub alternate: bool,
    pub zero: bool,
    pub width: Option<usize>,
    pub precision: Option<usize>,
    pub ty: FmtType,
}
Expand description

A complete format specification for dynamic formatting.

FormatSpec represents all the components of a format specification that can appear between the colons in a format string: "{:<5.2}". It controls how values are formatted including alignment, padding, width, precision, and type-specific formatting.

§Format String Components

A format specification in a string typically looks like: :[fill][align][sign][#][0][width][.precision][type]

Fields§

§fill: Option<char>

The fill character to use for padding.

If None, spaces will be used for padding.

§align: Option<Align>

The alignment of the formatted value within the field.

If None, the default alignment (typically right for numbers, left for text) will be used.

§sign: Option<Sign>

The sign display option for numeric values.

If None, signs will only be shown for negative numbers.

§alternate: bool

Whether to use alternate formatting.

For example, adding 0x prefix to hexadecimal numbers or always showing the decimal point.

§zero: bool

Whether to pad with zeros instead of the fill character.

This is typically used for numeric types to ensure a minimum number of digits.

§width: Option<usize>

The minimum width of the formatted field.

If the formatted value is shorter than this width, it will be padded according to the alignment.

§precision: Option<usize>

The precision for floating-point numbers or maximum length for strings.

§ty: FmtType

The format type specification.

Implementations§

Source§

impl FormatSpec

Source

pub fn fill_and_align(&self, s: String, default_align: Align) -> String

Applies fill and alignment to a string according to this format specification.

§Arguments
  • s - The string to format
  • default_align - The default alignment to use if none is specified

Trait Implementations§

Source§

impl Clone for FormatSpec

Source§

fn clone(&self) -> FormatSpec

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FormatSpec

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for FormatSpec

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for FormatSpec

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.