Skip to main content

Size

Struct Size 

Source
pub struct Size(/* private fields */);
Expand description

A non-negative byte count.

Size is the type used for budgets. It is parsed from human strings such as "280 KB", "2.5 MB" or "10700 B", and it renders back losslessly so that a config file survives a load/save round trip byte for byte.

§Examples

use wasmcheck::Size;

let size: Size = "280 KB".parse()?;
assert_eq!(size.bytes(), 280 * 1024);
assert_eq!(size.to_string(), "280 KB");

// An exact file measurement keeps its exact value.
let odd = Size::from_bytes(10_700);
assert_eq!(odd.to_string(), "10700 B");
assert_eq!("10700 B".parse::<Size>()?, odd);

Implementations§

Source§

impl Size

Source

pub const fn from_bytes(bytes: u64) -> Self

Wraps a raw byte count.

Source

pub const fn bytes(self) -> u64

The size in bytes.

Source

pub const fn from_kib_ceil(bytes: u64) -> Self

The smallest whole-KiB size that is greater than or equal to bytes.

This is how init derives a starting budget: rounding up guarantees the freshly written config does not fail its own first check.

§Examples
use wasmcheck::Size;

assert_eq!(Size::from_kib_ceil(10_700).bytes(), 11 * 1024);
assert_eq!(Size::from_kib_ceil(10_240).bytes(), 10 * 1024);
assert_eq!(Size::from_kib_ceil(0).bytes(), 0);

Trait Implementations§

Source§

impl Clone for Size

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Size

Source§

impl Debug for Size

Source§

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

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

impl Default for Size

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Size

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 Size

Source§

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

Formats the size losslessly: "11 KB", "2 MB" or "10700 B".

Source§

impl Eq for Size

Source§

impl From<Size> for u64

Source§

fn from(size: Size) -> Self

Converts to this type from the input type.
Source§

impl From<u64> for Size

Source§

fn from(bytes: u64) -> Self

Converts to this type from the input type.
Source§

impl FromStr for Size

Source§

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

Parses a size such as "280 KB", "2.5 MB", "512" or "10700 B".

Units are case-insensitive and "B", "KB"/"KiB" and "MB"/"MiB" are understood. Negative, non-finite and out-of-range values are rejected instead of silently saturating.

§Errors

Returns WasmCheckError::InvalidSize when the string is not a non-negative number followed by an optional known unit.

§Examples
use wasmcheck::Size;

assert_eq!("1.5 KB".parse::<Size>()?.bytes(), 1536);
assert!("-1 KB".parse::<Size>().is_err());
assert!("10 GB".parse::<Size>().is_err());
assert!("nan".parse::<Size>().is_err());
Source§

type Err = WasmCheckError

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

impl Hash for Size

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Size

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for Size

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Size

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for Size

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
Source§

impl StructuralPartialEq for Size

Auto Trait Implementations§

§

impl Forget for Size

§

impl Freeze for Size

§

impl RefUnwindSafe for Size

§

impl Send for Size

§

impl Sync for Size

§

impl Unpin for Size

§

impl UnsafeUnpin for Size

§

impl UnwindSafe for Size

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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.