Struct rocket::data::ByteUnit

source ·
#[repr(transparent)]
pub struct ByteUnit(/* private fields */);
Expand description

A unit of bytes with saturating const constructors and arithmetic.

Overview

A ByteUnit represents a unit, a count, a number, of bytes. All operations on a ByteUnit – constructors, arithmetic, conversions – saturate. Overflow, underflow, and divide-by-zero are impossible. See the top-level documentation for more.

ToByteUnit provides human-friendly methods on all integer types for converting into a ByteUnit: 512.megabytes().

Parsing

ByteUnit implements FromStr for parsing byte unit strings into a ByteUnit. The grammar accepted by the parser is:

byte_unit := uint+ ('.' uint+)? WHITESPACE* suffix

uint := '0'..'9'
suffix := case insensitive SI byte unit suffix ('b' to 'eib')
WHITESPACE := the ' ' character
use ubyte::{ByteUnit, ToByteUnit};

let one_gib: ByteUnit = "1GiB".parse().unwrap();
assert_eq!(one_gib, 1.gibibytes());

let quarter_mb: ByteUnit = "256 kB".parse().unwrap();
assert_eq!(quarter_mb, 256.kilobytes());

let half_mb: ByteUnit = "0.5MB".parse().unwrap();
assert_eq!(half_mb, 500.kilobytes());

let half_mib: ByteUnit = "0.500 mib".parse().unwrap();
assert_eq!(half_mib, 512.kibibytes());

let some_mb: ByteUnit = "20.5MB".parse().unwrap();
assert_eq!(some_mb, 20.megabytes() + 500.kilobytes());

(De)serialization

With the serde feaure enabled (disabled by default), ByteUnit implements Deserialize from strings, using the same grammar as the FromStr implementation, defined above, as well as all integer types. The Serialize implementation serializes into a u64.

Example

use ubyte::{ByteUnit, ToByteUnit};

// Construct with unit-valued associated constants, `const` constructors, or
// human-friendly methods from the `ToByteUnit` integer extension trait.
const HALF_GB: ByteUnit = ByteUnit::Megabyte(500);
const HALF_GIB: ByteUnit = ByteUnit::Mebibyte(512);
let half_gb = 500 * ByteUnit::MB;
let half_gib = 512 * ByteUnit::MiB;
let half_gb = 500.megabytes();
let half_gib = 512.mebibytes();

// All arithmetic operations and conversions saturate.
let exbibyte = ByteUnit::Exbibyte(1);
let exbibyte_too_large_a = 1024 * ByteUnit::EiB;
let exbibyte_too_large_b = ByteUnit::Exbibyte(1024);
let exbibyte_too_large_c = 1024.exbibytes();
let div_by_zero = 1024.exbibytes() / 0;
let too_small = 1000.megabytes() - 1.gibibytes();
assert_eq!(exbibyte << 4, ByteUnit::max_value());
assert_eq!(exbibyte << 10, ByteUnit::max_value());
assert_eq!(exbibyte_too_large_a, ByteUnit::max_value());
assert_eq!(exbibyte_too_large_b, ByteUnit::max_value());
assert_eq!(exbibyte_too_large_c, ByteUnit::max_value());
assert_eq!(div_by_zero, ByteUnit::max_value());
assert_eq!(too_small, 0);

Implementations§

source§

impl ByteUnit

source

pub const B: ByteUnit = _

Number of bytes in 1 B (1).

source

pub const kB: ByteUnit = _

Number of bytes in 1 kB (1_000).

source

pub const KiB: ByteUnit = _

Number of bytes in 1 KiB (1 << 10).

source

pub const MB: ByteUnit = _

Number of bytes in 1 MB (1_000_000).

source

pub const MiB: ByteUnit = _

Number of bytes in 1 MiB (1 << 20).

source

pub const GB: ByteUnit = _

Number of bytes in 1 GB (1_000_000_000).

source

pub const GiB: ByteUnit = _

Number of bytes in 1 GiB (1 << 30).

source

pub const TB: ByteUnit = _

Number of bytes in 1 TB (1_000_000_000_000).

source

pub const TiB: ByteUnit = _

Number of bytes in 1 TiB (1 << 40).

source

pub const PB: ByteUnit = _

Number of bytes in 1 PB (1_000_000_000_000_000).

source

pub const PiB: ByteUnit = _

Number of bytes in 1 PiB (1 << 50).

source

pub const EB: ByteUnit = _

Number of bytes in 1 EB (1_000_000_000_000_000_000).

source

pub const EiB: ByteUnit = _

Number of bytes in 1 EiB (1 << 60).

source

pub const fn Byte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n B .

Example
assert_eq!(ByteUnit::Byte(10), 10 * ByteUnit::B);
source

pub const fn Kilobyte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n kB .

Example
assert_eq!(ByteUnit::Kilobyte(10), 10 * ByteUnit::kB);
source

pub const fn Kibibyte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n KiB .

Example
assert_eq!(ByteUnit::Kibibyte(10), 10 * ByteUnit::KiB);
source

pub const fn Megabyte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n MB .

Example
assert_eq!(ByteUnit::Megabyte(10), 10 * ByteUnit::MB);
source

pub const fn Mebibyte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n MiB .

Example
assert_eq!(ByteUnit::Mebibyte(10), 10 * ByteUnit::MiB);
source

pub const fn Gigabyte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n GB .

Example
assert_eq!(ByteUnit::Gigabyte(10), 10 * ByteUnit::GB);
source

pub const fn Gibibyte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n GiB .

Example
assert_eq!(ByteUnit::Gibibyte(10), 10 * ByteUnit::GiB);
source

pub const fn Terabyte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n TB .

Example
assert_eq!(ByteUnit::Terabyte(10), 10 * ByteUnit::TB);
source

pub const fn Tebibyte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n TiB .

Example
assert_eq!(ByteUnit::Tebibyte(10), 10 * ByteUnit::TiB);
source

pub const fn Petabyte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n PB .

Example
assert_eq!(ByteUnit::Petabyte(10), 10 * ByteUnit::PB);
source

pub const fn Pebibyte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n PiB .

Example
assert_eq!(ByteUnit::Pebibyte(10), 10 * ByteUnit::PiB);
source

pub const fn Exabyte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n EB .

Example
assert_eq!(ByteUnit::Exabyte(10), 10 * ByteUnit::EB);
source

pub const fn Exbibyte(n: u64) -> ByteUnit

Constructs a ByteUnit representing n EiB .

Example
assert_eq!(ByteUnit::Exbibyte(10), 10 * ByteUnit::EiB);
source

pub const fn max_value() -> ByteUnit

The maximum value of bytes representable by ByteUnit.

Example
assert_eq!(ByteUnit::max_value(), u64::max_value());
source

pub const fn as_u64(self) -> u64

Returns the value of bytes represented by self as a u64.

Example
let int: u64 = ByteUnit::Gigabyte(4).as_u64();
assert_eq!(int, 4 * ByteUnit::GB);

assert_eq!(ByteUnit::Megabyte(42).as_u64(), 42 * 1_000_000);
assert_eq!(ByteUnit::Exbibyte(7).as_u64(), 7 * 1 << 60);
source

pub const fn as_u128(self) -> u128

Returns the value of bytes represented by self as a u128.

Example
let int: u128 = ByteUnit::Gigabyte(4).as_u128();
assert_eq!(int, 4 * ByteUnit::GB);

assert_eq!(ByteUnit::Megabyte(42).as_u64(), 42 * 1_000_000);
assert_eq!(ByteUnit::Exbibyte(7).as_u64(), 7 * 1 << 60);
source

pub fn repr(self) -> (u64, f64, &'static str, ByteUnit)

Returns the components of the minimal unit representation of self.

The “minimal unit representation” is the representation that maximizes the SI-unit while minimizing the whole part of the value. For example, 1024.bytes() is minimally represented by 1KiB, while 1023.bytes() is minimally represented by 1.023kB.

The four components returned, in tuple-order, are:

  • whole - the whole part of the minimal representation.
  • frac - the fractional part of the minimal representation.
  • suffix - the suffix of the minimal representation.
  • unit - the 1-unit of the minimal representation.

Succinctly, this is: (whole, frac, suffix, unit). Observe that `(whole

  • frac) * unit` reconstructs the original value.
Example
use ubyte::{ByteUnit, ToByteUnit};

let value = 2.mebibytes() + 512.kibibytes();
assert_eq!(value.to_string(), "2.50MiB");

let (whole, frac, suffix, unit) = value.repr();
assert_eq!(whole, 2);
assert_eq!(frac, 0.5);
assert_eq!(suffix, "MiB");
assert_eq!(unit, ByteUnit::MiB);

let reconstructed = (whole as f64 + frac) * unit.as_u64() as f64;
assert_eq!(reconstructed as u64, value);

Trait Implementations§

source§

impl Add<ByteUnit> for u64

§

type Output = ByteUnit

The resulting type after applying the + operator.
source§

fn add(self, rhs: ByteUnit) -> <u64 as Add<ByteUnit>>::Output

Performs the + operation. Read more
source§

impl<T> Add<T> for ByteUnitwhere T: Into<ByteUnit>,

§

type Output = ByteUnit

The resulting type after applying the + operator.
source§

fn add(self, rhs: T) -> <ByteUnit as Add<T>>::Output

Performs the + operation. Read more
source§

impl<T> AddAssign<T> for ByteUnitwhere T: Into<ByteUnit>,

source§

fn add_assign(&mut self, rhs: T)

Performs the += operation. Read more
source§

impl Clone for ByteUnit

source§

fn clone(&self) -> ByteUnit

Returns a copy 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 ByteUnit

source§

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

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

impl Default for ByteUnit

source§

fn default() -> ByteUnit

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

impl<'de> Deserialize<'de> for ByteUnit

source§

fn deserialize<D>( deserializer: D ) -> Result<ByteUnit, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for ByteUnit

Display self as best as possible. For perfectly custom display output, consider using ByteUnit::repr().

Example

use ubyte::{ByteUnit, ToByteUnit};

assert_eq!(323.kilobytes().to_string(), "323kB");
assert_eq!(3.megabytes().to_string(), "3MB");
assert_eq!(3.mebibytes().to_string(), "3MiB");

assert_eq!((3.mebibytes() + 140.kilobytes()).to_string(), "3.13MiB");
assert_eq!((3.mebibytes() + 2.mebibytes()).to_string(), "5MiB");
assert_eq!((7.gigabytes() + 58.mebibytes() + 3.kilobytes()).to_string(), "7.06GB");
assert_eq!((7.gibibytes() + 920.mebibytes()).to_string(), "7.90GiB");
assert_eq!(7231.kilobytes().to_string(), "6.90MiB");

assert_eq!(format!("{:.0}", 7.gibibytes() + 920.mebibytes()), "8GiB");
assert_eq!(format!("{:.1}", 7.gibibytes() + 920.mebibytes()), "7.9GiB");
assert_eq!(format!("{:.2}", 7.gibibytes() + 920.mebibytes()), "7.90GiB");
assert_eq!(format!("{:.3}", 7.gibibytes() + 920.mebibytes()), "7.898GiB");
assert_eq!(format!("{:.4}", 7.gibibytes() + 920.mebibytes()), "7.8984GiB");
assert_eq!(format!("{:.4}", 7231.kilobytes()), "6.8960MiB");
assert_eq!(format!("{:.0}", 7231.kilobytes()), "7MiB");
assert_eq!(format!("{:.2}", 999.kilobytes() + 990.bytes()), "976.55KiB");
assert_eq!(format!("{:.0}", 999.kilobytes() + 990.bytes()), "1MB");

assert_eq!(format!("{:04.2}", 999.kilobytes() + 990.bytes()), "0976.55KiB");
assert_eq!(format!("{:02.0}", 999.kilobytes() + 990.bytes()), "01MB");
assert_eq!(format!("{:04.0}", 999.kilobytes() + 990.bytes()), "0001MB");
source§

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

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

impl Div<ByteUnit> for u64

§

type Output = ByteUnit

The resulting type after applying the / operator.
source§

fn div(self, rhs: ByteUnit) -> <u64 as Div<ByteUnit>>::Output

Performs the / operation. Read more
source§

impl<T> Div<T> for ByteUnitwhere T: Into<ByteUnit>,

§

type Output = ByteUnit

The resulting type after applying the / operator.
source§

fn div(self, rhs: T) -> <ByteUnit as Div<T>>::Output

Performs the / operation. Read more
source§

impl<T> DivAssign<T> for ByteUnitwhere T: Into<ByteUnit>,

source§

fn div_assign(&mut self, rhs: T)

Performs the /= operation. Read more
source§

impl From<ByteUnit> for u64

source§

fn from(v: ByteUnit) -> u64

Converts to this type from the input type.
source§

impl From<i128> for ByteUnit

source§

fn from(value: i128) -> ByteUnit

Converts to this type from the input type.
source§

impl From<i16> for ByteUnit

source§

fn from(v: i16) -> ByteUnit

Converts to this type from the input type.
source§

impl From<i32> for ByteUnit

source§

fn from(v: i32) -> ByteUnit

Converts to this type from the input type.
source§

impl From<i64> for ByteUnit

source§

fn from(v: i64) -> ByteUnit

Converts to this type from the input type.
source§

impl From<i8> for ByteUnit

source§

fn from(v: i8) -> ByteUnit

Converts to this type from the input type.
source§

impl From<isize> for ByteUnit

source§

fn from(value: isize) -> ByteUnit

Converts to this type from the input type.
source§

impl From<u128> for ByteUnit

source§

fn from(value: u128) -> ByteUnit

Converts to this type from the input type.
source§

impl From<u16> for ByteUnit

source§

fn from(v: u16) -> ByteUnit

Converts to this type from the input type.
source§

impl From<u32> for ByteUnit

source§

fn from(v: u32) -> ByteUnit

Converts to this type from the input type.
source§

impl From<u64> for ByteUnit

source§

fn from(v: u64) -> ByteUnit

Converts to this type from the input type.
source§

impl From<u8> for ByteUnit

source§

fn from(v: u8) -> ByteUnit

Converts to this type from the input type.
source§

impl From<usize> for ByteUnit

source§

fn from(value: usize) -> ByteUnit

Converts to this type from the input type.
source§

impl FromStr for ByteUnit

§

type Err = Error

The associated error which can be returned from parsing.
source§

fn from_str(s: &str) -> Result<ByteUnit, <ByteUnit as FromStr>::Err>

Parses a string s to return a value of this type. Read more
source§

impl Hash for ByteUnit

source§

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Len<ByteUnit> for TempFile<'_>

source§

fn len(&self) -> ByteUnit

The length of the value.
source§

fn len_into_u64(len: ByteUnit) -> u64

Convert len into u64.
source§

fn zero_len() -> ByteUnit

The zero value for L.
source§

impl Mul<ByteUnit> for u64

§

type Output = ByteUnit

The resulting type after applying the * operator.
source§

fn mul(self, rhs: ByteUnit) -> <u64 as Mul<ByteUnit>>::Output

Performs the * operation. Read more
source§

impl<T> Mul<T> for ByteUnitwhere T: Into<ByteUnit>,

§

type Output = ByteUnit

The resulting type after applying the * operator.
source§

fn mul(self, rhs: T) -> <ByteUnit as Mul<T>>::Output

Performs the * operation. Read more
source§

impl<T> MulAssign<T> for ByteUnitwhere T: Into<ByteUnit>,

source§

fn mul_assign(&mut self, rhs: T)

Performs the *= operation. Read more
source§

impl Ord for ByteUnit

source§

fn cmp(&self, other: &ByteUnit) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

impl PartialEq<ByteUnit> for u64

source§

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

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

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.
source§

impl<T> PartialEq<T> for ByteUnitwhere T: Into<ByteUnit> + Copy,

source§

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

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

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.
source§

impl PartialOrd<ByteUnit> for u64

source§

fn partial_cmp(&self, other: &ByteUnit) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<T> PartialOrd<T> for ByteUnitwhere T: Into<ByteUnit> + Copy,

source§

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Rem<ByteUnit> for u64

§

type Output = ByteUnit

The resulting type after applying the % operator.
source§

fn rem(self, rhs: ByteUnit) -> <u64 as Rem<ByteUnit>>::Output

Performs the % operation. Read more
source§

impl<T> Rem<T> for ByteUnitwhere T: Into<ByteUnit>,

§

type Output = ByteUnit

The resulting type after applying the % operator.
source§

fn rem(self, rhs: T) -> <ByteUnit as Rem<T>>::Output

Performs the % operation. Read more
source§

impl<T> RemAssign<T> for ByteUnitwhere T: Into<ByteUnit>,

source§

fn rem_assign(&mut self, rhs: T)

Performs the %= operation. Read more
source§

impl Serialize for ByteUnit

source§

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Shl<ByteUnit> for u64

§

type Output = ByteUnit

The resulting type after applying the << operator.
source§

fn shl(self, rhs: ByteUnit) -> <u64 as Shl<ByteUnit>>::Output

Performs the << operation. Read more
source§

impl<T> Shl<T> for ByteUnitwhere T: Into<ByteUnit>,

§

type Output = ByteUnit

The resulting type after applying the << operator.
source§

fn shl(self, rhs: T) -> <ByteUnit as Shl<T>>::Output

Performs the << operation. Read more
source§

impl<T> ShlAssign<T> for ByteUnitwhere T: Into<ByteUnit>,

source§

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation. Read more
source§

impl Shr<ByteUnit> for u64

§

type Output = ByteUnit

The resulting type after applying the >> operator.
source§

fn shr(self, rhs: ByteUnit) -> <u64 as Shr<ByteUnit>>::Output

Performs the >> operation. Read more
source§

impl<T> Shr<T> for ByteUnitwhere T: Into<ByteUnit>,

§

type Output = ByteUnit

The resulting type after applying the >> operator.
source§

fn shr(self, rhs: T) -> <ByteUnit as Shr<T>>::Output

Performs the >> operation. Read more
source§

impl<T> ShrAssign<T> for ByteUnitwhere T: Into<ByteUnit>,

source§

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation. Read more
source§

impl Sub<ByteUnit> for u64

§

type Output = ByteUnit

The resulting type after applying the - operator.
source§

fn sub(self, rhs: ByteUnit) -> <u64 as Sub<ByteUnit>>::Output

Performs the - operation. Read more
source§

impl<T> Sub<T> for ByteUnitwhere T: Into<ByteUnit>,

§

type Output = ByteUnit

The resulting type after applying the - operator.
source§

fn sub(self, rhs: T) -> <ByteUnit as Sub<T>>::Output

Performs the - operation. Read more
source§

impl<T> SubAssign<T> for ByteUnitwhere T: Into<ByteUnit>,

source§

fn sub_assign(&mut self, rhs: T)

Performs the -= operation. Read more
source§

impl Copy for ByteUnit

source§

impl Eq for ByteUnit

source§

impl StructuralEq for ByteUnit

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Comparable<K> for Qwhere Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere 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> IntoCollection<T> for T

source§

fn into_collection<A>(self) -> SmallVec<A>where A: Array<Item = T>,

Converts self into a collection.
source§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>where F: FnMut(T) -> U, A: Array<Item = U>,

source§

impl<T> Paint for Twhere T: ?Sized,

source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to Color::Primary.

Example
println!("{}", value.primary());
source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to Color::Fixed.

Example
println!("{}", value.fixed(color));
source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

Example
println!("{}", value.rgb(r, g, b));
source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to Color::Black.

Example
println!("{}", value.black());
source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to Color::Red.

Example
println!("{}", value.red());
source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to Color::Green.

Example
println!("{}", value.green());
source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::Yellow.

Example
println!("{}", value.yellow());
source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::Blue.

Example
println!("{}", value.blue());
source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::Magenta.

Example
println!("{}", value.magenta());
source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::Cyan.

Example
println!("{}", value.cyan());
source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to Color::White.

Example
println!("{}", value.white());
source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlack.

Example
println!("{}", value.bright_black());
source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightRed.

Example
println!("{}", value.bright_red());
source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightGreen.

Example
println!("{}", value.bright_green());
source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightYellow.

Example
println!("{}", value.bright_yellow());
source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlue.

Example
println!("{}", value.bright_blue());
source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightMagenta.

Example
println!("{}", value.bright_magenta());
source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightCyan.

Example
println!("{}", value.bright_cyan());
source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightWhite.

Example
println!("{}", value.bright_white());
source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to Color::Primary.

Example
println!("{}", value.on_primary());
source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to Color::Fixed.

Example
println!("{}", value.on_fixed(color));
source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

Example
println!("{}", value.on_rgb(r, g, b));
source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::Black.

Example
println!("{}", value.on_black());
source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::Red.

Example
println!("{}", value.on_red());
source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::Green.

Example
println!("{}", value.on_green());
source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::Yellow.

Example
println!("{}", value.on_yellow());
source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::Blue.

Example
println!("{}", value.on_blue());
source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::Magenta.

Example
println!("{}", value.on_magenta());
source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::Cyan.

Example
println!("{}", value.on_cyan());
source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::White.

Example
println!("{}", value.on_white());
source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlack.

Example
println!("{}", value.on_bright_black());
source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightRed.

Example
println!("{}", value.on_bright_red());
source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightGreen.

Example
println!("{}", value.on_bright_green());
source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightYellow.

Example
println!("{}", value.on_bright_yellow());
source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlue.

Example
println!("{}", value.on_bright_blue());
source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightMagenta.

Example
println!("{}", value.on_bright_magenta());
source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightCyan.

Example
println!("{}", value.on_bright_cyan());
source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightWhite.

Example
println!("{}", value.on_bright_white());
source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Bold.

Example
println!("{}", value.bold());
source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Dim.

Example
println!("{}", value.dim());
source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Italic.

Example
println!("{}", value.italic());
source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Underline.

Example
println!("{}", value.underline());

Returns self with the attr() set to Attribute::Blink.

Example
println!("{}", value.blink());

Returns self with the attr() set to Attribute::RapidBlink.

Example
println!("{}", value.rapid_blink());
source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Invert.

Example
println!("{}", value.invert());
source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Conceal.

Example
println!("{}", value.conceal());
source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Strike.

Example
println!("{}", value.strike());
source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Mask.

Example
println!("{}", value.mask());
source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Wrap.

Example
println!("{}", value.wrap());
source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Linger.

Example
println!("{}", value.linger());
source§

fn clear(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Clear.

Example
println!("{}", value.clear());
source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Bright.

Example
println!("{}", value.bright());
source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::OnBright.

Example
println!("{}", value.on_bright());
source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
source§

fn new(self) -> Painted<Self>where Self: Sized,

Create a new Painted with a default Style. Read more
source§

fn paint<S>(&self, style: S) -> Painted<&Self>where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToByteUnit for Twhere T: Into<ByteUnit> + Copy,

source§

fn bytes(self) -> ByteUnit

Converts self to a ByteUnit representing self bytes.
source§

fn kilobytes(self) -> ByteUnit

Converts self to a ByteUnit representing self kB .
source§

fn kibibytes(self) -> ByteUnit

Converts self to a ByteUnit representing self KiB .
source§

fn megabytes(self) -> ByteUnit

Converts self to a ByteUnit representing self MB .
source§

fn mebibytes(self) -> ByteUnit

Converts self to a ByteUnit representing self MiB .
source§

fn gigabytes(self) -> ByteUnit

Converts self to a ByteUnit representing self GB .
source§

fn gibibytes(self) -> ByteUnit

Converts self to a ByteUnit representing self GiB .
source§

fn terabytes(self) -> ByteUnit

Converts self to a ByteUnit representing self TB .
source§

fn tibibytes(self) -> ByteUnit

Converts self to a ByteUnit representing self TiB .
source§

fn petabytes(self) -> ByteUnit

Converts self to a ByteUnit representing self PB .
source§

fn pebibytes(self) -> ByteUnit

Converts self to a ByteUnit representing self PiB .
source§

fn exabytes(self) -> ByteUnit

Converts self to a ByteUnit representing self EB .
source§

fn exbibytes(self) -> ByteUnit

Converts self to a ByteUnit representing self EiB .
source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

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

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

§

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 Twhere U: TryFrom<T>,

§

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.
source§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,