Enum smart_config::metadata::SizeUnit

#[non_exhaustive]
pub enum SizeUnit {
    Bytes,
    KiB,
    MiB,
    GiB,
}

Unit of byte size measurement.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bytes

Base unit – bytes.

KiB

Binary kilobyte (aka kibibyte) = 1,024 bytes.

MiB

Binary megabyte (aka mibibyte) = 1,048,576 bytes.

GiB

Binary gigabyte (aka gibibyte) = 1,073,741,824 bytes.

Trait Implementations

impl Clone for SizeUnit

fn clone(&self) -> SizeUnit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SizeUnit

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

Formats the value using the given formatter.

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 Display for SizeUnit

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<SizeUnit> for UnitOfMeasurement

fn from(unit: SizeUnit) -> Self

Converts to this type from the input type.

impl Hash for SizeUnit

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<SizeUnit> for u64

Panics on overflow.

type Output = ByteSize

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u64> for SizeUnit

Panics on overflow.

type Output = ByteSize

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for SizeUnit

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

impl Eq for SizeUnit

impl StructuralPartialEq for SizeUnit