Struct Sats 

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

Amount in satoshis (1 BTC = 100,000,000 sats)

Implementations

impl Sats

pub const ZERO: Sats

pub const _1: Sats

pub const _10: Sats

pub const _100: Sats

pub const _1K: Sats

pub const _10K: Sats

pub const _100K: Sats

pub const _1M: Sats

pub const _10M: Sats

pub const _1BTC: Sats = Self::ONE_BTC

pub const _10BTC: Sats

pub const _100BTC: Sats

pub const _1K_BTC: Sats

pub const _10K_BTC: Sats

pub const _100K_BTC: Sats

pub const ONE_BTC: Sats

pub const MAX: Sats

pub const COINBASE: Sats

pub const FIFTY_BTC: Sats

pub const ONE_BTC_U64: u64 = 1_00_000_000

pub const ONE_BTC_U128: u128 = 1_00_000_000

pub const ONE_BTC_I128: i128 = 1_00_000_000

pub fn new(sats: u64) -> Sats

pub fn is_zero(&self) -> bool

pub fn is_not_zero(&self) -> bool

pub const fn as_u128(self) -> u128

pub const fn as_i128(self) -> i128

pub fn is_max(&self) -> bool

pub fn is_common_round_value(&self) -> bool

Check if value is a “round” BTC amount (±0.1% of d × 10^n, d ∈ {1,2,3,5,6}). Used to filter out non-price-related transactions.

Methods from Deref<Target = u64>

pub const MIN: u64 = 0

pub const MAX: u64

pub const BITS: u32

Trait Implementations

impl Add for Sats

type Output = Sats

The resulting type after applying the + operator.

fn add(self, rhs: Sats) -> <Sats as Add>::Output

Performs the + operation.

impl AddAssign for Sats

fn add_assign(&mut self, rhs: Sats)

Performs the += operation.

impl Bytes for Sats

type Array = <u64 as Bytes>::Array

The byte array type returned by to_bytes. For fixed-size types, this is [u8; N] where N is the size of the type.

fn to_bytes(&self) -> <Sats as Bytes>::Array

Serializes this value to bytes.

fn from_bytes(bytes: &[u8]) -> Result<Sats, Error>

Deserializes a value from bytes.

const IS_NATIVE_LAYOUT: bool = false

Whether the byte representation from to_bytes is identical to the in-memory representation of Self. When true, bulk operations can use memcpy instead of per-element deserialization.

impl CheckedSub<usize> for Sats

fn checked_sub(self, rhs: usize) -> Option<Sats>

impl CheckedSub for Sats

fn checked_sub(self, rhs: Sats) -> Option<Sats>

impl Clone for Sats

fn clone(&self) -> Sats

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sats

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

Formats the value using the given formatter.

impl Default for Sats

fn default() -> Sats

Returns the “default value” for a type.

impl Deref for Sats

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &<Sats as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Sats

fn deserialize<__D>( __deserializer: __D, ) -> Result<Sats, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Sats

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

Formats the value using the given formatter.

impl Div<Dollars> for Sats

type Output = Sats

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<StoredU64> for Sats

type Output = Sats

The resulting type after applying the / operator.

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

Performs the / operation.

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 as Div>::Output

Performs the / operation.

impl Formattable for Sats

fn write_to(&self, buf: &mut Vec<u8>)

Write formatted UTF-8 bytes. Primary method — all others derive from it.

fn fmt_into(&self, f: &mut String)

Write to a String via write_to.

fn fmt_csv(&self, f: &mut String) -> Result<(), Error>

Write in CSV format. Override for types needing CSV escaping (e.g., quoting commas).

fn fmt_json(&self, buf: &mut Vec<u8>)

Write in JSON format. Override for types needing JSON wrapping (e.g., string quotes).

impl From<Amount> for Sats

fn from(value: Amount) -> Sats

Converts to this type from the input type.

impl From<Bitcoin> for Sats

fn from(value: Bitcoin) -> Sats

Converts to this type from the input type.

impl From<Sats> for AmountBucket

fn from(value: Sats) -> AmountBucket

Converts to this type from the input type.

impl From<Sats> for Bitcoin

fn from(value: Sats) -> Bitcoin

Converts to this type from the input type.

impl From<Sats> for SatsSigned

fn from(value: Sats) -> SatsSigned

Converts to this type from the input type.

impl From<Sats> for f64

fn from(value: Sats) -> f64

Converts to this type from the input type.

impl From<Sats> for u64

fn from(value: Sats) -> u64

Converts to this type from the input type.

impl From<Sats> for usize

fn from(value: Sats) -> usize

Converts to this type from the input type.

impl From<f32> for Sats

fn from(value: f32) -> Sats

Converts to this type from the input type.

impl From<f64> for Sats

fn from(value: f64) -> Sats

Converts to this type from the input type.

impl From<u128> for Sats

fn from(value: u128) -> Sats

Converts to this type from the input type.

impl From<u64> for Sats

fn from(value: u64) -> Sats

Converts to this type from the input type.

impl From<u8> for Sats

fn from(value: u8) -> Sats

Converts to this type from the input type.

impl From<usize> for Sats

fn from(value: usize) -> Sats

Converts to this type from the input 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 JsonSchema for Sats

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Mul<Height> for Sats

type Output = Sats

The resulting type after applying the * operator.

fn mul(self, rhs: Height) -> <Sats as Mul<Height>>::Output

Performs the * operation.

impl Mul<Sats> for Cents

type Output = CentsSats

The resulting type after applying the * operator.

fn mul(self, sats: Sats) -> CentsSats

Performs the * operation.

impl Mul<Sats> for Dollars

type Output = Dollars

The resulting type after applying the * operator.

fn mul(self, rhs: Sats) -> <Dollars as Mul<Sats>>::Output

Performs the * operation.

impl Mul<Sats> for usize

type Output = Sats

The resulting type after applying the * operator.

fn mul(self, rhs: Sats) -> <usize as Mul<Sats>>::Output

Performs the * operation.

impl Mul<StoredF64> for Sats

type Output = Sats

The resulting type after applying the * operator.

fn mul(self, rhs: StoredF64) -> <Sats as Mul<StoredF64>>::Output

Performs the * operation.

impl Mul<f64> for Sats

type Output = Sats

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> <Sats as Mul<f64>>::Output

Performs the * operation.

impl Mul<u64> for Sats

type Output = Sats

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> <Sats as Mul<u64>>::Output

Performs the * operation.

impl Mul<u8> for Sats

type Output = Sats

The resulting type after applying the * operator.

fn mul(self, rhs: u8) -> <Sats as Mul<u8>>::Output

Performs the * operation.

impl Mul<usize> for Sats

type Output = Sats

The resulting type after applying the * operator.

fn mul(self, rhs: usize) -> <Sats as Mul<usize>>::Output

Performs the * operation.

impl Mul for Sats

type Output = Sats

The resulting type after applying the * operator.

fn mul(self, rhs: Sats) -> <Sats as Mul>::Output

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

type NumberType = <u64 as Pco>::NumberType

impl SaturatingAdd for Sats

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

impl Serialize for Sats

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Sats

type Output = Sats

The resulting type after applying the - operator.

fn sub(self, rhs: Sats) -> <Sats as Sub>::Output

Performs the - operation.

impl SubAssign for Sats

fn sub_assign(&mut self, rhs: Sats)

Performs the -= operation.

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

impl Eq for Sats

impl StructuralPartialEq for Sats

impl TransparentPco<<u64 as Pco>::NumberType> for Sats