Sats

Struct Sats

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

Expand description

Satoshis

Implementations§

impl Sats

pub const ZERO: Self

pub const _1: Self

pub const _10: Self

pub const _100: Self

pub const _1K: Self

pub const _10K: Self

pub const _100K: Self

pub const _1M: Self

pub const _10M: Self

pub const _1BTC: Self = Self::ONE_BTC

pub const _10BTC: Self

pub const _100BTC: Self

pub const _1K_BTC: Self

pub const _10K_BTC: Self

pub const _100K_BTC: Self

pub const ONE_BTC: Self

pub const MAX: Self

pub const COINBASE: Self

pub const FIFTY_BTC: Self

pub const ONE_BTC_U128: u128 = 100_000_000u128

pub fn new(sats: u64) -> Self

pub fn is_zero(&self) -> bool

pub fn is_not_zero(&self) -> bool

pub fn is_max(&self) -> bool

Methods from Deref<Target = u64>§

1.43.0 · Source

pub const MIN: u64 = 0u64

1.43.0 · Source

pub const MAX: u64 = 18_446_744_073_709_551_615u64

1.53.0 · Source

pub const BITS: u32 = 64u32

Trait Implementations§

impl Add for Sats

type Output = Sats

The resulting type after applying the + operator.

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

Performs the + operation. Read more

impl AddAssign for Sats

fn add_assign(&mut self, rhs: Self)

Performs the += operation. Read more

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) -> Self::Array

Serializes this value to bytes. Read more

fn from_bytes(bytes: &[u8]) -> Result<Self>

Deserializes a value from bytes. Read more

impl CheckedSub<usize> for Sats

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

impl CheckedSub for Sats

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

impl Clone for Sats

fn clone(&self) -> Sats

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Sats

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

Formats the value using the given formatter. Read more

impl Default for Sats

fn default() -> Sats

Returns the “default value” for a type. Read more

impl Deref for Sats

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for Sats

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

Formats the value using the given formatter. Read more

impl Div<Dollars> for Sats

type Output = Sats

The resulting type after applying the / operator.

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

Performs the / operation. Read more

impl Div<usize> for Sats

type Output = Sats

The resulting type after applying the / operator.

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

Performs the / operation. Read more

impl Div for Sats

type Output = Sats

The resulting type after applying the / operator.

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

Performs the / operation. Read more

impl Formattable for Sats

fn may_need_escaping() -> bool

Returns true if this type might need escaping

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

Write the value in CSV format (with escaping if needed)

impl From<Amount> for Sats

fn from(value: Amount) -> Self

Converts to this type from the input type.

impl From<Bitcoin> for Sats

fn from(value: Bitcoin) -> Self

Converts to this type from the input type.

impl From<Sats> for Amount

fn from(value: Sats) -> Self

Converts to this type from the input type.

impl From<Sats> for Bitcoin

fn from(value: Sats) -> Self

Converts to this type from the input type.

impl From<Sats> for f64

fn from(value: Sats) -> Self

Converts to this type from the input type.

impl From<Sats> for u128

fn from(value: Sats) -> Self

Converts to this type from the input type.

impl From<Sats> for u64

fn from(value: Sats) -> Self

Converts to this type from the input type.

impl From<Sats> for usize

fn from(value: Sats) -> Self

Converts to this type from the input type.

impl From<f64> for Sats

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<u128> for Sats

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u64> for Sats

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Sats

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Sats

fn from(value: usize) -> Self

Converts to this type from the input type.

impl JsonSchema for Sats

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

The name of the generated JSON Schema. Read more

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

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

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

Generates a JSON Schema for this type. Read more

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. Read more

impl Mul<Height> for Sats

type Output = Sats

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<Sats> for Dollars

type Output = Dollars

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<Sats> for usize

type Output = Sats

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<StoredF64> for Sats

type Output = Sats

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<f64> for Sats

type Output = Sats

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<u64> for Sats

type Output = Sats

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<u8> for Sats

type Output = Sats

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<usize> for Sats

type Output = Sats

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul for Sats

type Output = Sats

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Ord for Sats

fn cmp(&self, other: &Sats) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

impl PartialEq for Sats

fn eq(&self, other: &Sats) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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. Read more

1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl Pco for Sats

type NumberType = <u64 as Pco>::NumberType

impl SaturatingAdd for Sats

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

impl Serialize for Sats

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Sub for Sats

type Output = Sats

The resulting type after applying the - operator.

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

Performs the - operation. Read more

impl SubAssign for Sats

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation. Read more

impl Sum for Sats

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

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

Auto Trait Implementations§

impl Freeze for Sats

impl RefUnwindSafe for Sats

impl Send for Sats

impl Sync for Sats

impl Unpin for Sats

impl UnwindSafe for Sats

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromInnerSlice<<T as Pco>::NumberType> for T
where T: PcoVecValue,

const _SIZE_CHECK: ()

const _ALIGN_CHECK: ()

fn from_inner_slice(vec: Vec<<T as Pco>::NumberType>) -> Vec<T>

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> BytesVecValue for T
where T: VecValue + Bytes,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> PcoVecValue for T
where T: Pco + BytesVecValue + Copy,

impl<T> VecValue for T
where T: Debug + Clone + Send + Sync + 'static,