Enum AssetCapacity 

pub enum AssetCapacity {
    Continuous(Capacity),
    Discrete(u32, Capacity),
}

Capacity of an asset, which may be continuous or a discrete number of indivisible units

Variants

Continuous(Capacity)

Continuous capacity

Discrete(u32, Capacity)

Discrete capacity represented by a number of indivisible units Stores: (number of units, unit size)

Implementations

impl AssetCapacity

fn check_same_unit_size(size1: Capacity, size2: Capacity)

Validates that two discrete capacities have the same unit size.

pub fn from_capacity(capacity: Capacity, unit_size: Option<Capacity>) -> Self

Create an AssetCapacity from a total capacity and optional unit size

If a unit size is provided, the capacity is represented as a discrete number of units, calculated as the ceiling of (capacity / unit_size). If no unit size is provided, the capacity is represented as continuous.

pub fn total_capacity(&self) -> Capacity

Returns the total capacity represented by this AssetCapacity.

pub fn n_units(&self) -> Option<u32>

Returns the number of units if this is a discrete capacity, or None if continuous.

pub fn assert_same_type(&self, other: AssetCapacity)

Asserts that both capacities are the same type (both continuous or both discrete).

pub fn apply_limit_factor(self, limit_factor: Dimensionless) -> Self

Applies a limit factor to the capacity, scaling it accordingly.

For discrete capacities, the number of units is scaled by the limit factor and rounded up to the nearest integer.

Trait Implementations

impl Add for AssetCapacity

type Output = AssetCapacity

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for AssetCapacity

fn clone(&self) -> AssetCapacity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssetCapacity

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

Formats the value using the given formatter.

impl Ord for AssetCapacity

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

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

fn partial_cmp(&self, other: &Self) -> 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 Sub for AssetCapacity

type Output = AssetCapacity

The resulting type after applying the - operator.

fn sub(self, rhs: AssetCapacity) -> Self

Performs the - operation.

impl Copy for AssetCapacity

impl Eq for AssetCapacity

impl StructuralPartialEq for AssetCapacity