Struct LedgerIndex

pub struct LedgerIndex(pub MilestoneIndex);

A wrapper type to represent the current ledger index.

Tuple Fields

0: MilestoneIndex

Implementations

impl LedgerIndex

pub fn new(index: MilestoneIndex) -> Self

Creates a new LedgerIndex.

Methods from Deref<Target = u32>

pub const MIN: u32 = 0u32

pub const MAX: u32 = 4_294_967_295u32

pub const BITS: u32 = 32u32

Trait Implementations

impl Clone for LedgerIndex

fn clone(&self) -> LedgerIndex

Returns a duplicate 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

Converts to this type from the input type.

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, Self: Sized,

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.

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 Packable for LedgerIndex

type UnpackError = <MilestoneIndex as Packable>::UnpackError

The error type that can be returned if some semantic error occurs while unpacking.

type UnpackVisitor = <MilestoneIndex as Packable>::UnpackVisitor

FIXME: docs

fn pack<P: Packer>(&self, packer: &mut P) -> Result<(), P::Error>

Packs this value into the given Packer.

fn unpack<U: Unpacker, const VERIFY: bool>( unpacker: &mut U, visitor: &Self::UnpackVisitor, ) -> Result<Self, UnpackError<Self::UnpackError, U::Error>>

Unpacks this value from the given Unpacker. The VERIFY generic parameter can be used to skip additional syntactic checks.

impl PartialEq for LedgerIndex

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

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

impl Eq for LedgerIndex

impl StructuralPartialEq for LedgerIndex