Struct ByteFormatter 

pub struct ByteFormatter { /* private fields */ }

A configurable formatter for byte sizes.

Examples

use prettier_bytes::{ByteFormatter, Standard};

let fmt = ByteFormatter::new().standard(Standard::SI);
assert_eq!(fmt.format(2500).as_str().unwrap(), "2.50 kB");

Implementations

impl ByteFormatter

pub const fn new() -> ByteFormatter

Creates a new ByteFormatter with sensible defaults: Binary standard (Base 1024), Bytes, and a space between the number and unit.

pub const fn standard(self, standard: Standard) -> ByteFormatter

Sets the formatting standard (e.g., SI vs Binary).

pub const fn unit(self, unit: Unit) -> ByteFormatter

Sets the base unit (e.g., Bytes vs Bits).

pub const fn space(self, space: bool) -> ByteFormatter

Determines whether a space is placed between the number and the unit.

Defaults to true (e.g., "1.50 MB"). If set to false, the space is omitted (e.g., "1.50MB").

Examples

use prettier_bytes::ByteFormatter;

let fmt_spaced = ByteFormatter::new().space(true);
assert_eq!(fmt_spaced.format(1024).as_str().unwrap(), "1.00 KiB");

let fmt_compact = ByteFormatter::new().space(false);
assert_eq!(fmt_compact.format(1024).as_str().unwrap(), "1.00KiB");

pub fn format(self, val: u64) -> FormattedBytes

Formats the given value and returns a stack-allocated buffer.

Trait Implementations

impl Clone for ByteFormatter

fn clone(&self) -> ByteFormatter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ByteFormatter

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

Formats the value using the given formatter.

impl Default for ByteFormatter

fn default() -> ByteFormatter

Returns the “default value” for a type.

impl PartialEq for ByteFormatter

fn eq(&self, other: &ByteFormatter) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ByteFormatter

impl Eq for ByteFormatter

impl StructuralPartialEq for ByteFormatter