Struct MemSize 

pub struct MemSize(/* private fields */);

A memory quantity in bytes, used for memory-limit thresholds

Parses the Flockfile grammar ^\d+(G|M|K)?$ (binary units; plain digits are bytes). Ordering compares byte counts, so a configured limit compares directly against a sampled RSS wrapped with MemSize::from_bytes.

Example

use shep_core::values::MemSize;

let limit: MemSize = "512M".parse()?;
assert_eq!(limit.bytes(), 512 << 20);
assert!("512MB".parse::<MemSize>().is_err()); // strict grammar

Implementations

impl MemSize

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

Wraps a raw byte count, e.g. an RSS sample

pub const fn bytes(self) -> u64

Returns the quantity in bytes

Trait Implementations

impl Clone for MemSize

fn clone(&self) -> MemSize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MemSize

impl Debug for MemSize

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MemSize

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

Deserialize this value from the given Serde deserializer.

impl Display for MemSize

Formats with the largest binary unit dividing the value exactly; output always re-parses to the same value

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

Formats the value using the given formatter.

impl Eq for MemSize

impl FromStr for MemSize

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

Parses ^\d+(G|M|K)?$: binary units, plain digits = bytes

Errors

• ParseMemSizeError::Empty: empty input.
• ParseMemSizeError::MissingDigits: unit suffix with no digits.
• ParseMemSizeError::InvalidCharacter: anything outside ASCII digits plus one trailing G/M/K (lowercase, whitespace, fractions, multi-letter suffixes all land here).
• ParseMemSizeError::Overflow: byte count exceeds u64::MAX.

type Err = ParseMemSizeError

The associated error which can be returned from parsing.

impl Hash for MemSize

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 JsonSchema for MemSize

Available on crate feature schema only.

String-shaped, matching this type’s Serialize/Deserialize, which go through Display/FromStr rather than the wrapped u64. A derive here would emit {"type":"integer"} and describe a wire form that does not exist.

The pattern is FromStr’s own grammar, lifted from its doc comment above. If you change one, change the other: the paired test below is what catches it.

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

The name of the generated JSON Schema.

fn json_schema(_: &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 MemSize

fn cmp(&self, other: &MemSize) -> 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.

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.

impl PartialEq for MemSize

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MemSize

fn partial_cmp(&self, other: &MemSize) -> 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 MemSize

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MemSize