Struct ByteSize

pub struct ByteSize(/* private fields */);

Represents a size in bytes.

ByteSize can be parsed from strings or with Serde, and remembers the original unit that was used to describe it for stable serialization. Use ByteSize::infer to infer the most appropriate unit for a number of bytes.

Units based on 1000 and 1024 are both supported:

• To refer to the 1000-based versions, use “kB” and “MB”.
• To refer to the 1024-based versions, use “KiB” and “MiB”.

Examples

Infer the best unit:

use relay_config::ByteSize;

let size = ByteSize::infer(42 * 1000 * 1000);
assert_eq!("42MB", size.to_string());

Format a 1024-based size to string:

use relay_config::ByteSize;

let size = ByteSize::kibibytes(42);
assert_eq!("42KiB", size.to_string());

Implementations

impl ByteSize

pub fn infer(value: u32) -> Self

Create a byte size from bytes, inferring the most appropriate unit.

pub fn bytes(value: u32) -> Self

Create a byte size from bytes.

pub fn kibibytes(value: u32) -> Self

Create a byte size from 1024-based kibibytes.

pub fn mebibytes(value: u32) -> Self

Create a byte size from 1024-based mebibytes.

pub fn as_bytes(&self) -> usize

Return the value in bytes.

Trait Implementations

impl Debug for ByteSize

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ByteSize

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ByteSize

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

Formats the value using the given formatter.

impl From<u32> for ByteSize

fn from(value: u32) -> ByteSize

Converts to this type from the input type.

impl FromStr for ByteSize

type Err = ParsingError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for ByteSize

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

where S: Serializer,

Serialize this value into the given Serde serializer.