Struct bee_ledger::types::LedgerIndex

pub struct LedgerIndex(pub MilestoneIndex);

A wrapper type to represent the current ledger index.

Implementations

impl LedgerIndex

pub fn new(index: MilestoneIndex) -> Self

Creates a new LedgerIndex.

Methods from Deref<Target = u32>

pub const MIN: u32

pub const MAX: u32

pub const BITS: u32

Trait Implementations

impl Clone for LedgerIndex

fn clone(&self) -> LedgerIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LedgerIndex

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

Formats the value using the given formatter.

impl Default for LedgerIndex

fn default() -> LedgerIndex

Returns the “default value” for a type.

impl Deref for LedgerIndex

type Target = <MilestoneIndex as Deref>::Target

The resulting type after dereferencing.

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

Dereferences the value.

impl From<MilestoneIndex> for LedgerIndex

fn from(index: MilestoneIndex) -> Self

Performs the conversion.

impl Hash for LedgerIndex

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for LedgerIndex

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

Restrict a value to a certain interval.

impl Packable for LedgerIndex

type Error = Error

Associated error type.

fn packed_len(&self) -> usize

Returns the length of the packed bytes.

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

Packs the instance to bytes and writes them to the passed writer.

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error>

Reads bytes from the passed reader and unpacks them into an instance.

fn pack_new(&self) -> Vec<u8, Global>

Packs the instance to bytes and writes them to a newly allocated vector.

fn unpack<R>(reader: &mut R) -> Result<Self, Self::Error> where
    R: Read + ?Sized, 

Reads bytes from the passed reader and unpacks them into an instance. Applies syntactic checks.

fn unpack_unchecked<R>(reader: &mut R) -> Result<Self, Self::Error> where
    R: Read + ?Sized, 

Reads bytes from the passed reader and unpacks them into an instance. Doesn’t apply syntactic checks.

impl PartialEq<LedgerIndex> for LedgerIndex

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

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

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

This method tests for !=.

impl PartialOrd<LedgerIndex> for LedgerIndex

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl Copy for LedgerIndex

impl Eq for LedgerIndex

impl StructuralEq for LedgerIndex

impl StructuralPartialEq for LedgerIndex