Skip to main content

SatsSigned

Struct SatsSigned

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

Expand description

Signed satoshis (i64) - for values that can be negative. Used for changes, deltas, profit/loss calculations, etc.

Implementations§

impl SatsSigned

pub const ZERO: SatsSigned

pub const fn new(value: i64) -> SatsSigned

pub const fn inner(self) -> i64

pub fn is_zero(&self) -> bool

pub fn is_negative(&self) -> bool

pub fn is_positive(&self) -> bool

pub fn abs(self) -> SatsSigned

Methods from Deref<Target = i64>§

1.43.0 · Source

pub const MIN: i64

1.43.0 · Source

pub const MAX: i64

1.53.0 · Source

pub const BITS: u32 = u64::BITS

Trait Implementations§

impl Add for SatsSigned

type Output = SatsSigned

The resulting type after applying the + operator.

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

Performs the + operation. Read more

impl AddAssign for SatsSigned

fn add_assign(&mut self, rhs: SatsSigned)

Performs the += operation. Read more

impl Bytes for SatsSigned

type Array = <i64 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) -> <SatsSigned as Bytes>::Array

Serializes this value to bytes. Read more

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

Deserializes a value from bytes. Read more

impl CheckedSub for SatsSigned

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

impl Clone for SatsSigned

fn clone(&self) -> SatsSigned

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 SatsSigned

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

Formats the value using the given formatter. Read more

impl Default for SatsSigned

fn default() -> SatsSigned

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

impl Deref for SatsSigned

type Target = i64

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for SatsSigned

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

Deserialize this value from the given Serde deserializer. Read more

impl Display for SatsSigned

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

Formats the value using the given formatter. Read more

impl Div<usize> for SatsSigned

type Output = SatsSigned

The resulting type after applying the / operator.

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

Performs the / operation. Read more

impl Formattable for SatsSigned

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<Bitcoin> for SatsSigned

fn from(value: Bitcoin) -> SatsSigned

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<SatsSigned> for Bitcoin

fn from(value: SatsSigned) -> Bitcoin

Converts to this type from the input type.

impl From<SatsSigned> for f32

fn from(value: SatsSigned) -> f32

Converts to this type from the input type.

impl From<SatsSigned> for f64

fn from(value: SatsSigned) -> f64

Converts to this type from the input type.

impl From<SatsSigned> for i64

fn from(value: SatsSigned) -> i64

Converts to this type from the input type.

impl From<f32> for SatsSigned

fn from(value: f32) -> SatsSigned

Converts to this type from the input type.

impl From<f64> for SatsSigned

fn from(value: f64) -> SatsSigned

Converts to this type from the input type.

impl From<i64> for SatsSigned

fn from(value: i64) -> SatsSigned

Converts to this type from the input type.

impl From<usize> for SatsSigned

fn from(value: usize) -> SatsSigned

Converts to this type from the input type.

impl JsonSchema for SatsSigned

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<i64> for SatsSigned

type Output = SatsSigned

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<usize> for SatsSigned

type Output = SatsSigned

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Neg for SatsSigned

type Output = SatsSigned

The resulting type after applying the - operator.

fn neg(self) -> <SatsSigned as Neg>::Output

Performs the unary - operation. Read more

impl Ord for SatsSigned

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

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

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

type NumberType = <i64 as Pco>::NumberType

impl Serialize for SatsSigned

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

impl Sub for SatsSigned

type Output = SatsSigned

The resulting type after applying the - operator.

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

Performs the - operation. Read more

impl SubAssign for SatsSigned

fn sub_assign(&mut self, rhs: SatsSigned)

Performs the -= operation. Read more

impl Sum for SatsSigned

fn sum<I>(iter: I) -> SatsSigned
where I: Iterator<Item = SatsSigned>,

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

impl Copy for SatsSigned

impl Eq for SatsSigned

impl StructuralPartialEq for SatsSigned

impl TransparentPco<<i64 as Pco>::NumberType> for SatsSigned

Auto Trait Implementations§

impl Freeze for SatsSigned

impl RefUnwindSafe for SatsSigned

impl Send for SatsSigned

impl Sync for SatsSigned

impl Unpin for SatsSigned

impl UnwindSafe for SatsSigned

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<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<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,