Enum UpperBound

pub enum UpperBound {
    Inclusive(Decimal),
    Unbounded,
}

Represents an upper bound on a non-negative decimal.

UpperBound::Unbounded represents an upper bound above any possible decimal, and is included for clarity of intention. Considering Decimal has a max size, it is effectively equivalent to an inclusive bound of Decimal::MAX.

You can extract this equivalent decimal using the Self::equivalent_decimal method.

Invariants

• The amount in LowerBound::Inclusive(amount) is required to be non-negative before using this model. This can be validated via ManifestResourceConstraint::is_valid_for.

Trait Implementations

• Ord, PartialOrd - Satisfies AmountInclusive(Any) < Unbounded

Variants

Inclusive(Decimal)

Unbounded

Implementations

impl UpperBound

pub const fn unbounded() -> UpperBound

pub const fn zero() -> UpperBound

pub fn at_most(decimal: Decimal) -> UpperBound

Panics

• Panics if the decimal is not resolvable or is non-negative

pub fn of(upper_bound: impl Resolve<UpperBound>) -> UpperBound

pub fn validate_amount( &self, amount: &Decimal, ) -> Result<(), ResourceConstraintError>

pub fn is_valid_for_fungible_use(&self) -> bool

pub fn is_valid_for_non_fungible_use(&self) -> bool

pub fn add_from( &mut self, other: UpperBound, ) -> Result<(), BoundAdjustmentError>

pub fn take_amount( &mut self, take_amount: Decimal, ) -> Result<(), BoundAdjustmentError>

PRECONDITION: take_amount must be positive

pub fn constrain_to(&mut self, other_bound: UpperBound)

pub fn equivalent_decimal(&self) -> Decimal

Trait Implementations

impl Categorize<ManifestCustomValueKind> for UpperBound

fn value_kind() -> ValueKind<ManifestCustomValueKind>

impl Categorize<ScryptoCustomValueKind> for UpperBound

fn value_kind() -> ValueKind<ScryptoCustomValueKind>

impl Clone for UpperBound

fn clone(&self) -> UpperBound

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpperBound

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

Formats the value using the given formatter.

impl<D> Decode<ManifestCustomValueKind, D> for UpperBound

where D: Decoder<ManifestCustomValueKind>,

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<ManifestCustomValueKind>, ) -> Result<UpperBound, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl<D> Decode<ScryptoCustomValueKind, D> for UpperBound

where D: Decoder<ScryptoCustomValueKind>,

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<ScryptoCustomValueKind>, ) -> Result<UpperBound, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl Describe<ScryptoCustomTypeKind> for UpperBound

const TYPE_ID: RustTypeId

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<ScryptoCustomTypeKind, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<ScryptoCustomTypeKind>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl<E> Encode<ManifestCustomValueKind, E> for UpperBound

where E: Encoder<ManifestCustomValueKind>,

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl<E> Encode<ScryptoCustomValueKind, E> for UpperBound

where E: Encoder<ScryptoCustomValueKind>,

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl Ord for UpperBound

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

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

fn partial_cmp(&self, other: &UpperBound) -> 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<T> ResolveFrom<T> for UpperBound

where T: Resolve<Decimal>,

fn resolve_from(value: T) -> UpperBound

impl ResolveFrom<UpperBound> for UpperBound

fn resolve_from(value: UpperBound) -> UpperBound

impl SborEnum<ManifestCustomValueKind> for UpperBound

fn get_discriminator(&self) -> u8

fn get_length(&self) -> usize

impl SborEnum<ScryptoCustomValueKind> for UpperBound

fn get_discriminator(&self) -> u8

fn get_length(&self) -> usize

impl Copy for UpperBound

impl Eq for UpperBound

impl Resolvable for UpperBound

impl StructuralPartialEq for UpperBound