Struct strfmt::Formatter

pub struct Formatter<'a, 'b> {
    pub key: &'a str,
    /* private fields */
}

Fields

key: &'a str

Implementations

impl<'a, 'b> Formatter<'a, 'b>

implement formatting of strings

pub fn str(&mut self, s: &str) -> Result<()>

format the given string onto the buffer

pub fn str_unchecked(&mut self, s: &str) -> Result<()>

UNSTABLE+UNTESTED: do not use in your own code (yet) Do the same as str but do not check the format string for errors. This gives a moderate performance boost. This isn’t exactly unsafe, it just ends up ignoring extranious format specifiers For example, {x:<-#10} should technically be formatting an int, but ignoring the integer specific formatting is probably not the end of the world This can also be used by the u64 etc methods to finish their formatting while still using the str formatter for width and alignment

impl<'a, 'b> Formatter<'a, 'b>

pub fn from_str(s: &'a str, buff: &'b mut String) -> Result<Formatter<'a, 'b>>

create Formatter from format string

pub fn skip(self) -> Result<()>

call this to re-write the original format string verbatum back to the output

pub fn fill(&self) -> char

fill getter

pub fn align(&self) -> Alignment

align getter

pub fn set_default_align(&mut self, align: Alignment)

pub fn width(&self) -> Option<usize>

width getter

pub fn thousands(&self) -> bool

thousands getter

pub fn precision(&self) -> Option<usize>

precision getter

pub fn set_precision(&mut self, precision: Option<usize>)

set precision to None, used for formatting int, float, etc

pub fn sign(&self) -> Sign

sign getter

pub fn sign_plus(&self) -> bool

sign plus getter here because it is in fmt::Formatter

pub fn sign_minus(&self) -> bool

sign minus getter here because it is in fmt::Formatter

pub fn alternate(&self) -> bool

alternate getter

pub fn ty(&self) -> Option<char>

type getter

pub fn is_int_type(&self) -> bool

UNSTABLE: in the future, this may return true if all validty checks for a float return true return true if ty is valid for formatting integers

pub fn is_float_type(&self) -> bool

UNSTABLE: in the future, this may return true if all validty checks for a float return true return true if ty is valid for formatting floats

impl<'a, 'b> Formatter<'a, 'b>

pub fn u8(&mut self, x: u8) -> Result<()>

impl<'a, 'b> Formatter<'a, 'b>

pub fn i8(&mut self, x: i8) -> Result<()>

impl<'a, 'b> Formatter<'a, 'b>

pub fn u16(&mut self, x: u16) -> Result<()>

impl<'a, 'b> Formatter<'a, 'b>

pub fn i16(&mut self, x: i16) -> Result<()>

impl<'a, 'b> Formatter<'a, 'b>

pub fn u32(&mut self, x: u32) -> Result<()>

impl<'a, 'b> Formatter<'a, 'b>

pub fn i32(&mut self, x: i32) -> Result<()>

impl<'a, 'b> Formatter<'a, 'b>

pub fn u64(&mut self, x: u64) -> Result<()>

impl<'a, 'b> Formatter<'a, 'b>

pub fn i64(&mut self, x: i64) -> Result<()>

impl<'a, 'b> Formatter<'a, 'b>

pub fn usize(&mut self, x: usize) -> Result<()>

impl<'a, 'b> Formatter<'a, 'b>

pub fn isize(&mut self, x: isize) -> Result<()>

impl<'a, 'b> Formatter<'a, 'b>

pub fn f32(&mut self, x: f32) -> Result<()>

impl<'a, 'b> Formatter<'a, 'b>

pub fn f64(&mut self, x: f64) -> Result<()>

Trait Implementations

impl<'a, 'b> Debug for Formatter<'a, 'b>

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

Formats the value using the given formatter.

impl<'a, 'b> PartialEq<Formatter<'a, 'b>> for Formatter<'a, 'b>

fn eq(&self, other: &Formatter<'a, 'b>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b> Write for Formatter<'a, 'b>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl<'a, 'b> StructuralPartialEq for Formatter<'a, 'b>