Struct Capacity

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

CKB capacity.

It is encoded as the amount of Shannons internally.

Implementations

impl Capacity

pub const fn zero() -> Self

Capacity of zero Shannons.

pub const fn one() -> Self

Capacity of one Shannon.

pub const fn shannons(val: u64) -> Self

Views the capacity as Shannons.

pub fn bytes(val: usize) -> Result<Self>

Views the capacity as CKBytes.

pub fn as_u64(self) -> u64

Views the capacity as Shannons.

pub fn safe_add<C: IntoCapacity>(self, rhs: C) -> Result<Self>

Adds self and rhs and checks overflow error.

pub fn safe_sub<C: IntoCapacity>(self, rhs: C) -> Result<Self>

Subtracts self and rhs and checks overflow error.

pub fn safe_mul<C: IntoCapacity>(self, rhs: C) -> Result<Self>

Multiplies self and rhs and checks overflow error.

pub fn safe_mul_ratio(self, ratio: Ratio) -> Result<Self>

Multiplies self with a ratio and checks overflow error.

Trait Implementations

impl Clone for Capacity

fn clone(&self) -> Capacity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Capacity

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

Formats the value using the given formatter.

impl Default for Capacity

fn default() -> Capacity

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Capacity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Capacity

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

Formats the value using the given formatter.

impl FromStr for Capacity

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Capacity

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

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 IntoCapacity for Capacity

fn into_capacity(self) -> Capacity

Converts self into Capacity.

impl LowerHex for Capacity

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

Formats the value using the given formatter.

impl Ord for Capacity

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Capacity

impl Eq for Capacity

impl StructuralPartialEq for Capacity