Struct size::fmt::SizeFormatter

pub struct SizeFormatter<T: FormatterSize = ()> { /* private fields */ }

A standalone size formatter that is configured via the builder pattern (via the various .with_ methods) which can then be used to format an integral byte value as a pretty printed String in accordance with the configured properties.

Use of the strongly typed Size to hold and display sizes is strongly preferred over this approach, but it may come in handy when you have many sizes and all need to be formatted in an identical and manually-specified fashion.

use size::{Base, Size, SizeFormatter, Style};

let formatter = SizeFormatter::new()
    .with_base(Base::Base10)
    .with_style(Style::Abbreviated);

for raw_size in [ 1024, 2048, 4096 ]
{
    let formatted = formatter.format(raw_size);
    println!("{}", &formatted);
}

// Prints:
// 1.02 KB
// 2.05 KB
// 4.10 KB

Implementations

impl<T: FormatterSize> SizeFormatter<T>

pub fn with_base(self, base: Base) -> Self

Specify the base of the units to be used when generating the textual description of the Size.

This lets users choose between “standard” base-10 units like “KB” and “MB” or the improved SI base-2 units like “KiB” and “MiB”. See Base for more information.

pub fn with_style(self, style: Style) -> Self

Specify the style used to write the accompanying unit for a formatted file size.

See Style for more information.

impl SizeFormatter<()>

pub const fn new() -> SizeFormatter<()>

Create a new SizeFormatter that can be used to repeatedly format a number of file sizes according to its configured options.

pub fn format(&self, bytes: i64) -> String

Formats a provided size in bytes as a string, per the configuration of the current SizeFormatter instance.

impl SizeFormatter<&'a Size>

pub fn to_string(&self) -> String

Returns the formatted Size as a String, formatted according to the current state of the SizeFormatter instance as modified via with_style(), with_base(), and co.