Struct bee_tangle::metadata::IndexId

pub struct IndexId(_, _);

A type used to associate two particular interesting Cone Root Indexes with a message in the Tangle, i.e. the Oldest Cone Root Index (OCRI), and the Youngest Cone Root Index (YCRI)

Implementations

impl IndexId

pub fn new(index: MilestoneIndex, id: MessageId) -> Self

Create a new IndexId.

pub fn index(&self) -> MilestoneIndex

Get the milestone index of this IndexId.

pub fn id(&self) -> MessageId

Get the message ID of this IndexId.

pub fn set_index(&mut self, index: MilestoneIndex)

Update this IndexId with a new milestone index.

Trait Implementations

impl Clone for IndexId

fn clone(&self) -> IndexId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for IndexId

impl Debug for IndexId

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

Formats the value using the given formatter.

impl Eq for IndexId

impl Ord for IndexId

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

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl Packable for IndexId

type Error = IndexIdError

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.

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

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

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

pub 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<IndexId> for IndexId

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<IndexId> for IndexId

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

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

#[must_use]

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

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

#[must_use]

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

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

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

#[must_use]

pub 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 Serialize for IndexId

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

Serialize this value into the given Serde serializer.