Struct relay_config::ByteSize

source ·
pub struct ByteSize(/* private fields */);
Expand description

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§

source§

impl ByteSize

source

pub fn infer(value: u32) -> Self

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

source

pub fn bytes(value: u32) -> Self

Create a byte size from bytes.

source

pub fn kibibytes(value: u32) -> Self

Create a byte size from 1024-based kibibytes.

source

pub fn mebibytes(value: u32) -> Self

Create a byte size from 1024-based mebibytes.

source

pub fn as_bytes(&self) -> usize

Return the value in bytes.

Trait Implementations§

source§

impl Debug for ByteSize

source§

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

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

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

source§

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

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

impl Display for ByteSize

source§

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

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

impl From<u32> for ByteSize

source§

fn from(value: u32) -> ByteSize

Converts to this type from the input type.
source§

impl FromStr for ByteSize

§

type Err = ParsingError

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

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

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

impl Serialize for ByteSize

source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
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 T
where 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> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToString for T
where 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 T
where 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 T
where 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.
§

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

§

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 T
where T: for<'de> Deserialize<'de>,