Struct AssetAmount 

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

A validated fungible asset amount.

Wraps a u64 that is guaranteed to be at most AssetAmount::MAX. This type is used in FungibleAsset to ensure the amount is always valid.

Implementations

impl AssetAmount

pub const MAX: Self

The maximum value an asset amount can represent.

Equal to 2^63 - 2^31. This was chosen so that the amount fits as both a positive and negative value in a field element.

pub const ZERO: Self

The zero amount.

pub fn new(amount: u64) -> Result<Self, AssetError>

Returns a new AssetAmount if amount does not exceed Self::MAX.

Errors

Returns an error if amount is greater than Self::MAX.

pub const fn as_u64(&self) -> u64

Returns the underlying u64 value.

pub const fn as_i64(&self) -> i64

Returns the underlying value as an i64.

SAFETY: this cast never truncates or wraps because Self::MAX (2^63 - 2^31) is strictly less than i64::MAX (2^63 - 1), so every valid AssetAmount fits in a non-negative i64.

Trait Implementations

impl Add for AssetAmount

type Output = Result<AssetAmount, AssetError>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl Clone for AssetAmount

fn clone(&self) -> AssetAmount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssetAmount

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

Formats the value using the given formatter.

impl Default for AssetAmount

fn default() -> AssetAmount

Returns the “default value” for a type.

impl Deserializable for AssetAmount

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl Display for AssetAmount

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

Formats the value using the given formatter.

impl From<AssetAmount> for Felt

fn from(amount: AssetAmount) -> Self

Converts to this type from the input type.

impl From<AssetAmount> for u64

fn from(amount: AssetAmount) -> Self

Converts to this type from the input type.

impl From<u16> for AssetAmount

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for AssetAmount

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u8> for AssetAmount

fn from(value: u8) -> Self

Converts to this type from the input type.

impl Hash for AssetAmount

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 Ord for AssetAmount

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

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

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

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

impl Sub for AssetAmount

type Output = Result<AssetAmount, AssetError>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl TryFrom<Felt> for AssetAmount

type Error = AssetError

The type returned in the event of a conversion error.

fn try_from(value: Felt) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for AssetAmount

type Error = AssetError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for AssetAmount

impl Eq for AssetAmount

impl StructuralPartialEq for AssetAmount