Struct Amount 

pub struct Amount<C = NegativeAllowed>(i64, PhantomData<C>);

A runtime validated type for representing amounts of zatoshis

Tuple Fields

0: i64

The inner amount value.

1: PhantomData<C>

Used for Constraint type inference.

Correctness

This internal Zebra marker type is not consensus-critical. And it should be ignored during testing. (And other internal uses.)

Implementations

impl Amount<NonNegative>

pub const fn new_from_zec(zec_value: i64) -> Self

Create a new non-negative Amount from a provided value in ZEC.

pub const fn new(zatoshis: i64) -> Self

Create a new non-negative Amount from a provided value in zatoshis.

pub const fn div_exact(self, rhs: i64) -> Self

Divide an Amount by a value that the amount fits into evenly such that there is no remainder.

impl<C> Amount<C>

pub fn constrain<C2>(self) -> Result<Amount<C2>>

where C2: Constraint,

Convert this amount to a different Amount type if it satisfies the new constraint

pub fn zatoshis(&self) -> i64

Returns the number of zatoshis in this amount.

pub fn checked_sub<C2: Constraint>(self, rhs: Amount<C2>) -> Option<Amount>

Checked subtraction. Computes self - rhs, returning None if overflow occurred.

pub fn to_bytes(&self) -> [u8; 8]

To little endian byte array

pub fn from_bytes(bytes: [u8; 8]) -> Result<Amount<C>>

where C: Constraint,

From little endian byte array

pub fn zero() -> Amount<C>

where C: Constraint,

Create a zero Amount

pub fn is_zero(&self) -> bool

Returns true if this amount is zero.

Trait Implementations

impl<C> Add<Amount<C>> for Result<Amount<C>>

where C: Constraint,

type Output = Result<Amount<C>, Error>

The resulting type after applying the + operator.

fn add(self, rhs: Amount<C>) -> Self::Output

Performs the + operation.

impl<C> Add<Result<Amount<C>, Error>> for Amount<C>

where C: Constraint,

type Output = Result<Amount<C>, Error>

The resulting type after applying the + operator.

fn add(self, rhs: Result<Amount<C>>) -> Self::Output

Performs the + operation.

impl<C> Add for Amount<C>

where C: Constraint,

type Output = Result<Amount<C>, Error>

The resulting type after applying the + operator.

fn add(self, rhs: Amount<C>) -> Self::Output

Performs the + operation.

impl<C> AddAssign<Amount<C>> for Result<Amount<C>>

where Amount<C>: Copy, C: Constraint,

fn add_assign(&mut self, rhs: Amount<C>)

Performs the += operation.

impl<C> Arbitrary for Amount<C>

where C: Constraint + Debug,

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<Amount<C>>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl<C: Clone> Clone for Amount<C>

fn clone(&self) -> Amount<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Debug for Amount<C>

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

Formats the value using the given formatter.

impl<C: Default> Default for Amount<C>

fn default() -> Amount<C>

Returns the “default value” for a type.

impl<'de, C> Deserialize<'de> for Amount<C>

where C: Constraint + Clone,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C> Display for Amount<C>

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

Formats the value using the given formatter.

impl<C> Div<u64> for Amount<C>

where C: Constraint,

type Output = Result<Amount<C>, Error>

The resulting type after applying the / operator.

fn div(self, rhs: u64) -> Self::Output

Performs the / operation.

impl<C> From<Amount<C>> for Scalar

fn from(a: Amount<C>) -> Scalar

Converts to this type from the input type.

impl<C> From<Amount<C>> for Fr

fn from(a: Amount<C>) -> Fr

Converts to this type from the input type.

impl<C> From<Amount<C>> for i64

fn from(amount: Amount<C>) -> Self

Converts to this type from the input type.

impl From<Amount<NonNegative>> for u64

fn from(amount: Amount<NonNegative>) -> Self

Converts to this type from the input type.

impl<C> Hash for Amount<C>

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

Amounts with the same value are equal, even if they have different constraints

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<C> Mul<Amount<C>> for u64

where C: Constraint,

type Output = Result<Amount<C>, Error>

The resulting type after applying the * operator.

fn mul(self, rhs: Amount<C>) -> Self::Output

Performs the * operation.

impl<C> Mul<u64> for Amount<C>

where C: Constraint,

type Output = Result<Amount<C>, Error>

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Self::Output

Performs the * operation.

impl<C> Neg for Amount<C>

where C: Constraint,

type Output = Amount

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<C> Ord for Amount<C>

fn cmp(&self, other: &Amount<C>) -> 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<C> PartialEq<Amount<C>> for i64

fn eq(&self, other: &Amount<C>) -> 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<C1, C2> PartialEq<Amount<C2>> for Amount<C1>

fn eq(&self, other: &Amount<C2>) -> 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<C> PartialEq<i64> for Amount<C>

fn eq(&self, other: &i64) -> 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<C1, C2> PartialOrd<Amount<C2>> for Amount<C1>

fn partial_cmp(&self, other: &Amount<C2>) -> 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<C> Serialize for Amount<C>

where C: Constraint + Clone,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C> Sub<Amount<C>> for Result<Amount<C>>

where C: Constraint,

type Output = Result<Amount<C>, Error>

The resulting type after applying the - operator.

fn sub(self, rhs: Amount<C>) -> Self::Output

Performs the - operation.

impl<C> Sub<Result<Amount<C>, Error>> for Amount<C>

where C: Constraint,

type Output = Result<Amount<C>, Error>

The resulting type after applying the - operator.

fn sub(self, rhs: Result<Amount<C>>) -> Self::Output

Performs the - operation.

impl<C> Sub for Amount<C>

where C: Constraint,

type Output = Result<Amount<C>, Error>

The resulting type after applying the - operator.

fn sub(self, rhs: Amount<C>) -> Self::Output

Performs the - operation.

impl<C> SubAssign<Amount<C>> for Result<Amount<C>>

where Amount<C>: Copy, C: Constraint,

fn sub_assign(&mut self, rhs: Amount<C>)

Performs the -= operation.

impl<'amt, C> Sum<&'amt Amount<C>> for Result<Amount<C>>

where C: Constraint + Copy + 'amt,

fn sum<I: Iterator<Item = &'amt Amount<C>>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<C> Sum<Amount<C>> for Result<Amount<C>>

where C: Constraint,

fn sum<I: Iterator<Item = Amount<C>>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<Amount<NonNegative>> for Zatoshis

Convert a Zebra non-negative Amount into a librustzcash one.

type Error = BalanceError

The type returned in the event of a conversion error.

fn try_from(amount: Amount<NonNegative>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Amount> for ZatBalance

type Error = BalanceError

The type returned in the event of a conversion error.

fn try_from(amount: Amount) -> Result<Self, Self::Error>

Performs the conversion.

impl<C> TryFrom<i128> for Amount<C>

where C: Constraint,

Conversion from i128 to Amount.

Used to handle the result of multiplying negative Amounts by u64.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<C> TryFrom<i32> for Amount<C>

where C: Constraint,

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<C> TryFrom<i64> for Amount<C>

where C: Constraint,

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<C> TryFrom<u64> for Amount<C>

where C: Constraint,

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ZcashDeserialize for Amount<NegativeAllowed>

fn zcash_deserialize<R: Read>(reader: R) -> Result<Self, SerializationError>

Try to read self from the given reader.

impl ZcashDeserialize for Amount<NonNegative>

fn zcash_deserialize<R: Read>(reader: R) -> Result<Self, SerializationError>

Try to read self from the given reader.

impl ZcashSerialize for Amount<NegativeAllowed>

fn zcash_serialize<W: Write>(&self, writer: W) -> Result<(), Error>

Write self to the given writer using the canonical format.

fn zcash_serialize_to_vec(&self) -> Result<Vec<u8>, Error>

Helper function to construct a vec to serialize the current struct into

fn zcash_serialized_size(&self) -> usize

Get the size of self by using a fake writer.

impl ZcashSerialize for Amount<NonNegative>

fn zcash_serialize<W: Write>(&self, writer: W) -> Result<(), Error>

Write self to the given writer using the canonical format.

fn zcash_serialize_to_vec(&self) -> Result<Vec<u8>, Error>

Helper function to construct a vec to serialize the current struct into

fn zcash_serialized_size(&self) -> usize

Get the size of self by using a fake writer.

impl<C: Copy> Copy for Amount<C>

impl<C> Eq for Amount<C>

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes