Struct Sats

pub struct Sats(pub u64);

Tuple Fields

0: u64

Implementations

impl Sats

pub const ZERO: Sats

pub const BTC: Sats

pub const fn from_btc(btc: u32) -> Sats

pub fn from_sats(sats: impl Into<u64>) -> Sats

pub const fn is_zero(&self) -> bool

pub const fn is_non_zero(&self) -> bool

pub const fn btc_round(&self) -> u64

pub const fn btc_ceil(&self) -> u64

pub const fn btc_floor(&self) -> u64

pub const fn sats(&self) -> u64

pub fn sats_i64(&self) -> i64

pub const fn sats_rem(&self) -> u64

pub const fn btc_sats(&self) -> (u64, u64)

pub fn checked_add(&self, other: impl Into<Sats>) -> Option<Sats>

pub fn checked_sub(&self, other: impl Into<Sats>) -> Option<Sats>

pub fn checked_add_assign(&mut self, other: impl Into<Sats>) -> Option<Sats>

pub fn checked_sub_assign(&mut self, other: impl Into<Sats>) -> Option<Sats>

pub fn saturating_add(&self, other: impl Into<Sats>) -> Sats

pub fn saturating_sub(&self, other: impl Into<Sats>) -> Sats

pub fn saturating_add_assign(&mut self, other: impl Into<Sats>)

pub fn saturating_sub_assign(&mut self, other: impl Into<Sats>)

Trait Implementations

impl Add for Sats

type Output = Sats

The resulting type after applying the + operator.

fn add(self, rhs: Sats) -> Sats

Performs the + operation.

impl AddAssign for Sats

fn add_assign(&mut self, rhs: Sats)

Performs the += operation.

impl AsMut<<Sats as Wrapper>::Inner> for Sats

fn as_mut(&mut self) -> &mut <Sats as Wrapper>::Inner

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<u64> for Sats

fn as_ref(&self) -> &u64

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<u64> for Sats

fn borrow(&self) -> &u64

Immutably borrows from an owned value.

impl BorrowMut<<Sats as Wrapper>::Inner> for Sats

fn borrow_mut(&mut self) -> &mut <Sats as Wrapper>::Inner

Mutably borrows from an owned value.

impl Clone for Sats

fn clone(&self) -> Sats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConsensusDecode for Sats

fn consensus_decode( reader: &mut impl Read, ) -> Result<Sats, ConsensusDecodeError>

fn consensus_deserialize( bytes: impl AsRef<[u8]>, ) -> Result<Self, ConsensusDecodeError>

impl ConsensusEncode for Sats

fn consensus_encode(&self, writer: &mut impl Write) -> Result<usize, IoError>

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

impl Debug for Sats

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

Formats the value using the given formatter.

impl Decode for Sats

fn decode(reader: &mut impl Read) -> Result<Sats, DecodeError>

fn deserialize(bytes: impl AsRef<[u8]>) -> Result<Self, PsbtError>

impl Default for Sats

fn default() -> Sats

Returns the “default value” for a type.

impl Display for Sats

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

Formats the value using the given formatter.

impl Div<usize> for Sats

type Output = Sats

The resulting type after applying the / operator.

fn div(self, rhs: usize) -> <Sats as Div<usize>>::Output

Performs the / operation.

impl Div for Sats

type Output = Sats

The resulting type after applying the / operator.

fn div(self, rhs: Sats) -> Sats

Performs the / operation.

impl DivAssign for Sats

fn div_assign(&mut self, rhs: Sats)

Performs the /= operation.

impl Encode for Sats

fn encode(&self, writer: &mut dyn Write) -> Result<usize, IoError>

impl From<u16> for Sats

fn from(v: u16) -> Sats

Converts to this type from the input type.

impl From<u32> for Sats

fn from(v: u32) -> Sats

Converts to this type from the input type.

impl From<u64> for Sats

fn from(v: u64) -> Sats

Converts to this type from the input type.

impl From<u8> for Sats

fn from(v: u8) -> Sats

Converts to this type from the input type.

impl FromStr for Sats

type Err = <<Sats as Wrapper>::Inner as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Sats, <Sats as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Sats

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

where __H: Hasher,

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 Mul for Sats

type Output = Sats

The resulting type after applying the * operator.

fn mul(self, rhs: Sats) -> Sats

Performs the * operation.

impl MulAssign for Sats

fn mul_assign(&mut self, rhs: Sats)

Performs the *= operation.

impl Ord for Sats

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

fn eq(&self, other: &u64) -> 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 PartialEq for Sats

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

fn partial_cmp(&self, other: &Sats) -> 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 Rem<usize> for Sats

type Output = Sats

The resulting type after applying the % operator.

fn rem(self, rhs: usize) -> <Sats as Rem<usize>>::Output

Performs the % operation.

impl RemAssign for Sats

fn rem_assign(&mut self, rhs: Sats)

Performs the %= operation.

impl StrictDecode for Sats

fn strict_decode(reader: &mut impl TypedRead) -> Result<Sats, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictEncode for Sats

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

where W: TypedWrite,

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictTuple for Sats

const FIELD_COUNT: u8 = 1u8

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for Sats

const STRICT_LIB_NAME: &'static str = LIB_NAME_BITCOIN

fn strict_name() -> Option<TypeName>

impl Sub for Sats

type Output = Sats

The resulting type after applying the - operator.

fn sub(self, rhs: Sats) -> Sats

Performs the - operation.

impl SubAssign for Sats

fn sub_assign(&mut self, rhs: Sats)

Performs the -= operation.

impl Sum<u64> for Sats

fn sum<I>(iter: I) -> Sats

where I: Iterator<Item = u64>,

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

impl Sum for Sats

fn sum<I>(iter: I) -> Sats

where I: Iterator<Item = Sats>,

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

impl Wrapper for Sats

type Inner = u64

Inner type wrapped by the current newtype

fn from_inner(inner: <Sats as Wrapper>::Inner) -> Sats

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &<Sats as Wrapper>::Inner

Returns reference to the inner representation for the wrapper type

fn into_inner(self) -> <Sats as Wrapper>::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

where Self::Inner: Clone,

Clones inner data of the wrapped type and return them

fn copy(&self) -> Self

where Self: Sized, Self::Inner: Copy,

Copies the wrapped type

impl WrapperMut for Sats

fn as_inner_mut(&mut self) -> &mut <Sats as Wrapper>::Inner

Returns a mutable reference to the inner representation for the wrapper type

impl Copy for Sats

impl Eq for Sats

impl StrictProduct for Sats

impl StructuralPartialEq for Sats