Struct ByteSize 

pub struct ByteSize(pub usize);

A byte size that can be deserialized from either an integer (raw bytes) or a string with a unit suffix (KB, MB, GB, case-insensitive).

Examples: 67108864, "64MB", "1 GB", "512kb".

Negative, non-finite, and overflowing values are rejected:

use dora_message::config::ByteSize;

assert_eq!("64MB".parse::<ByteSize>().unwrap().as_bytes(), 64 * 1024 * 1024);
assert_eq!("1.5 KB".parse::<ByteSize>().unwrap().as_bytes(), 1536);
assert!("-1KB".parse::<ByteSize>().is_err());
assert!("1TB".parse::<ByteSize>().is_err());

Tuple Fields

0: usize

Implementations

impl ByteSize

pub fn as_bytes(&self) -> usize

Returns the size in raw bytes.

Trait Implementations

impl Clone for ByteSize

fn clone(&self) -> ByteSize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ByteSize

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 Eq for ByteSize

impl FromStr for ByteSize

type Err = String

The associated error which can be returned from parsing.

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

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

impl JsonSchema for ByteSize

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(_gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for ByteSize

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ByteSize

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ByteSize

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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.

impl StructuralPartialEq for ByteSize