Struct smart_config::ByteSize

pub struct ByteSize(pub u64);

A wrapper providing a clear reminder that the wrapped value represents the number of bytes.

Examples

In non-const context, the most idiomatic way to produce a size is to multiply SizeUnit by u64:

let size = 128 * SizeUnit::MiB;
assert_eq!(size, ByteSize(128 << 20));

In const context, Self::new() may be used instead:

const SIZE: ByteSize = ByteSize::new(128, SizeUnit::MiB);
assert_eq!(SIZE, ByteSize(128 << 20));

Tuple Fields

0: u64

Implementations

impl ByteSize

pub const fn checked(val: u64, unit: SizeUnit) -> Option<Self>

Creates a value with the specified unit of measurement checking for overflow.

pub const fn new(val: u64, unit: SizeUnit) -> Self

Creates a value with the specified unit of measurement.

Panics

Panics on overflow.

pub const fn checked_add(self, rhs: Self) -> Option<Self>

Adds two byte sizes.

pub const fn checked_mul(self, factor: u64) -> Option<Self>

Multiplies this size by the given factor.

Trait Implementations

impl Add for ByteSize

Panics on overflow.

type Output = ByteSize

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Clone for ByteSize

fn clone(&self) -> ByteSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CustomKnownOption for ByteSize

type OptDeserializer = Optional<WithUnit, true>

Type of the deserializer used for Option<Self>.

const OPT_DE: Self::OptDeserializer = _

Deserializer instance.

impl Debug for ByteSize

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

Formats the value using the given formatter.

impl Default for ByteSize

fn default() -> ByteSize

Returns the “default value” for a type.

impl DeserializeParam<ByteSize> for SizeUnit

Supports deserializing a ByteSize from a number, with self being the unit of measurement.

Examples

use smart_config::testing;

#[derive(DescribeConfig, DeserializeConfig)]
struct TestConfig {
    #[config(with = SizeUnit::MiB)]
    size_mb: ByteSize,
}

let source = smart_config::config!("size_mb": 4);
let config = testing::test::<TestConfig>(source)?;
assert_eq!(config.size_mb, ByteSize(4 << 20));

const EXPECTING: BasicTypes = BasicTypes::INTEGER

Describes which parameter this deserializer is expecting.

fn describe(&self, description: &mut TypeDescription)

Additional info about the deserialized type, e.g., extended description.

fn deserialize_param( &self, ctx: DeserializeContext<'_>, param: &'static ParamMetadata, ) -> Result<ByteSize, ErrorWithOrigin>

Performs deserialization given the context and param metadata.

fn serialize_param(&self, param: &ByteSize) -> Value

Serializes the provided parameter to the JSON model.

impl DeserializeParam<ByteSize> for WithUnit

const EXPECTING: BasicTypes = Self::EXPECTED_TYPES

Describes which parameter this deserializer is expecting.

fn describe(&self, description: &mut TypeDescription)

Additional info about the deserialized type, e.g., extended description.

fn deserialize_param( &self, ctx: DeserializeContext<'_>, param: &'static ParamMetadata, ) -> Result<ByteSize, ErrorWithOrigin>

Performs deserialization given the context and param metadata.

fn serialize_param(&self, param: &ByteSize) -> Value

Serializes the provided parameter to the JSON model.

impl Display for ByteSize

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

Formats the value using the given formatter.

impl From<SizeUnit> for ByteSize

fn from(unit: SizeUnit) -> Self

Converts to this type from the input type.

impl From<u64> for ByteSize

fn from(value: u64) -> Self

Converts to this type from the input type.

impl Hash for ByteSize

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<u64> for ByteSize

Panics on overflow.

type Output = ByteSize

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Self::Output

Performs the * operation.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ByteSize

fn eq(&self, other: &ByteSize) -> 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 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 WellKnown for ByteSize

type Deserializer = WithUnit

Type of the deserializer used for this type.

const DE: Self::Deserializer = WithUnit

Deserializer instance.

impl Copy for ByteSize

impl Eq for ByteSize

impl StructuralPartialEq for ByteSize