Struct Zatoshis

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

A type-safe representation of some nonnegative amount of Zcash.

A Zatoshis can only be constructed from an integer that is within the valid monetary range of {0..MAX_MONEY} (where MAX_MONEY = 21,000,000 × 10⁸ zatoshis).

Implementations

impl Zatoshis

pub const ZERO: Self

Returns the identity Zatoshis

pub fn into_u64(self) -> u64

Returns this Zatoshis as a u64.

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

Creates a Zatoshis from a u64.

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

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

Creates a constant Zatoshis from a u64.

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

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

Creates a Zatoshis from an i64.

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

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

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

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

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

Reads a Zatoshis from a signed integer represented as a two’s complement 64-bit little-endian value.

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

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

Returns this Zatoshis encoded as a signed two’s complement 64-bit little-endian value.

pub fn is_zero(&self) -> bool

Returns whether or not this Zatoshis is the zero value.

pub fn is_positive(&self) -> bool

Returns whether or not this Zatoshis is positive.

pub fn div_with_remainder(&self, divisor: NonZeroU64) -> QuotRem<Zatoshis>

Divides this Zatoshis value by the given divisor and returns the quotient and remainder.

Trait Implementations

impl Add<Zatoshis> for Option<Zatoshis>

type Output = Option<Zatoshis>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Zatoshis

type Output = Option<Zatoshis>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Zatoshis

fn clone(&self) -> Zatoshis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Zatoshis

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

Formats the value using the given formatter.

impl Div<NonZero<u64>> for Zatoshis

type Output = Zatoshis

The resulting type after applying the / operator.

fn div(self, rhs: NonZeroU64) -> Zatoshis

Performs the / operation.

impl From<&Zatoshis> for ZatBalance

fn from(n: &Zatoshis) -> Self

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<Zatoshis> for u64

fn from(n: Zatoshis) -> Self

Converts to this type from the input type.

impl Mul<u64> for Zatoshis

type Output = Option<Zatoshis>

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Option<Zatoshis>

Performs the * operation.

impl Mul<usize> for Zatoshis

type Output = Option<Zatoshis>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Ord for Zatoshis

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

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

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

type Output = Option<Zatoshis>

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Zatoshis

type Output = Option<Zatoshis>

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

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

impl Sum<Zatoshis> for Option<Zatoshis>

fn sum<I: Iterator<Item = Zatoshis>>(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<u64> for Zatoshis

type Error = BalanceError

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 Zatoshis

impl Eq for Zatoshis

impl StructuralPartialEq for Zatoshis