Struct ZatBalance

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

A type-safe representation of a Zcash value delta, in zatoshis.

An ZatBalance can only be constructed from an integer that is within the valid monetary range of {-MAX_MONEY..MAX_MONEY} (where MAX_MONEY = 21,000,000 × 10⁸ zatoshis), and this is preserved as an invariant internally. (A Transaction containing serialized invalid ZatBalances would also be rejected by the network consensus rules.)

Implementations

impl ZatBalance

pub const fn zero() -> Self

Returns a zero-valued ZatBalance.

pub const fn const_from_i64(amount: i64) -> Self

Creates a constant ZatBalance from an i64.

Panics: if the amount is outside the range {-MAX_BALANCE..MAX_BALANCE}.

pub const fn const_from_u64(amount: u64) -> Self

Creates a constant ZatBalance from a u64.

Panics: if the amount is outside the range {0..MAX_BALANCE}.

pub fn from_i64(amount: i64) -> Result<Self, BalanceError>

Creates an ZatBalance from an i64.

Returns an error if the amount is outside the range {-MAX_BALANCE..MAX_BALANCE}.

pub fn from_nonnegative_i64(amount: i64) -> Result<Self, BalanceError>

Creates a non-negative ZatBalance from an i64.

Returns an error if the amount is outside the range {0..MAX_BALANCE}.

pub fn from_u64(amount: u64) -> Result<Self, BalanceError>

Creates an ZatBalance from a u64.

Returns an error if the amount is outside the range {0..MAX_MONEY}.

pub fn from_i64_le_bytes(bytes: [u8; 8]) -> Result<Self, BalanceError>

Reads an ZatBalance from a signed 64-bit little-endian integer.

Returns an error if the amount is outside the range {-MAX_BALANCE..MAX_BALANCE}.

pub fn from_nonnegative_i64_le_bytes( bytes: [u8; 8], ) -> Result<Self, BalanceError>

Reads a non-negative ZatBalance from a signed 64-bit little-endian integer.

Returns an error if the amount is outside the range {0..MAX_BALANCE}.

pub fn from_u64_le_bytes(bytes: [u8; 8]) -> Result<Self, BalanceError>

Reads an ZatBalance from an unsigned 64-bit little-endian integer.

Returns an error if the amount is outside the range {0..MAX_BALANCE}.

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

Returns the ZatBalance encoded as a signed 64-bit little-endian integer.

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the ZatBalance is zero or negative.

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the ZatBalance is zero or positive.

pub fn sum<I: IntoIterator<Item = ZatBalance>>(values: I) -> Option<ZatBalance>

Trait Implementations

impl Add<ZatBalance> for Option<ZatBalance>

type Output = Option<ZatBalance>

The resulting type after applying the + operator.

fn add(self, rhs: ZatBalance) -> Option<ZatBalance>

Performs the + operation.

impl Add for ZatBalance

type Output = Option<ZatBalance>

The resulting type after applying the + operator.

fn add(self, rhs: ZatBalance) -> Option<ZatBalance>

Performs the + operation.

impl Clone for ZatBalance

fn clone(&self) -> ZatBalance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZatBalance

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

Formats the value using the given formatter.

impl DynamicUsage for ZatBalance

fn dynamic_usage(&self) -> usize

Returns a best estimate of the amount of heap-allocated memory used by this type.

fn dynamic_usage_bounds(&self) -> (usize, Option<usize>)

Returns the lower and upper bounds on the amount of heap-allocated memory used by this type.

impl From<&ZatBalance> for i64

fn from(amount: &ZatBalance) -> i64

Converts to this type from the input type.

impl From<&Zatoshis> for ZatBalance

fn from(n: &Zatoshis) -> Self

Converts to this type from the input type.

impl From<ZatBalance> for i64

fn from(amount: ZatBalance) -> i64

Converts to this type from the input type.

impl From<Zatoshis> for ZatBalance

fn from(n: Zatoshis) -> Self

Converts to this type from the input type.

impl Mul<usize> for ZatBalance

type Output = Option<ZatBalance>

The resulting type after applying the * operator.

fn mul(self, rhs: usize) -> Option<ZatBalance>

Performs the * operation.

impl Neg for ZatBalance

type Output = ZatBalance

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for ZatBalance

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

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

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

type Output = Option<ZatBalance>

The resulting type after applying the - operator.

fn sub(self, rhs: ZatBalance) -> Option<ZatBalance>

Performs the - operation.

impl Sub for ZatBalance

type Output = Option<ZatBalance>

The resulting type after applying the - operator.

fn sub(self, rhs: ZatBalance) -> Option<ZatBalance>

Performs the - operation.

impl<'a> Sum<&'a ZatBalance> for Option<ZatBalance>

fn sum<I: Iterator<Item = &'a ZatBalance>>(iter: I) -> Self

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

impl Sum<ZatBalance> for Option<ZatBalance>

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

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

impl TryFrom<ZatBalance> for Zatoshis

type Error = BalanceError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<ZatBalance> for u64

type Error = BalanceError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i64> for ZatBalance

type Error = BalanceError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for ZatBalance

impl Eq for ZatBalance

impl StructuralPartialEq for ZatBalance