Struct ckb_types::core::Capacity

pub struct Capacity(_);

CKB capacity.

It is encoded as the amount of Shannons internally.

Implementations

impl Capacity

pub const fn zero() -> Capacity

Capacity of zero Shannons.

pub const fn one() -> Capacity

Capacity of one Shannon.

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

Views the capacity as Shannons.

pub fn bytes(val: usize) -> Result<Capacity, Error>

Views the capacity as CKBytes.

pub fn as_u64(self) -> u64

Views the capacity as Shannons.

pub fn safe_add<C>(self, rhs: C) -> Result<Capacity, Error> where
    C: AsCapacity, 

Adds self and rhs and checks overflow error.

pub fn safe_sub<C>(self, rhs: C) -> Result<Capacity, Error> where
    C: AsCapacity, 

Subtracts self and rhs and checks overflow error.

pub fn safe_mul<C>(self, rhs: C) -> Result<Capacity, Error> where
    C: AsCapacity, 

Multiplies self and rhs and checks overflow error.

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

Multiplies self with a ratio and checks overflow error.

Trait Implementations

impl AsCapacity for Capacity

pub fn as_capacity(self) -> Capacity

Converts self into Capacity.

impl Clone for Capacity

pub fn clone(&self) -> Capacity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Capacity

impl Debug for Capacity

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

Formats the value using the given formatter.

impl Default for Capacity

pub fn default() -> Capacity

Returns the "default value" for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl Display for Capacity

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

Formats the value using the given formatter.

impl Eq for Capacity

impl FromStr for Capacity

type Err = ParseIntError

The associated error which can be returned from parsing.

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

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

impl Hash for Capacity

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for Capacity

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

Formats the value using the given formatter.

impl Ord for Capacity

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Pack<Uint64> for Capacity

fn pack(&self) -> Uint64

Packs a rust type into binary data.

impl PartialEq<Capacity> for Capacity

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

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Capacity) -> bool

This method tests for !=.

impl PartialOrd<Capacity> for Capacity

pub fn partial_cmp(&self, other: &Capacity) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Capacity

pub 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 StructuralEq for Capacity

impl StructuralPartialEq for Capacity

impl<'r> Unpack<Capacity> for Uint64Reader<'r>

fn unpack(&self) -> Capacity

Unpack binary data into rust types.

impl Unpack<Capacity> for Uint64

fn unpack(&self) -> Capacity

Unpack binary data into rust types.