MessageMetadata

Struct MessageMetadata 

Source
pub struct MessageMetadata { /* private fields */ }
Expand description

Metadata associated with a tangle message.

Implementations§

Source§

impl MessageMetadata

Source

pub fn new( flags: Flags, milestone_index: Option<MilestoneIndex>, arrival_timestamp: u64, solidification_timestamp: u64, reference_timestamp: u64, omrsi: Option<IndexId>, ymrsi: Option<IndexId>, conflict: ConflictReason, ) -> Self

Create a new instance of a message’s metadata.

Source

pub fn arrived() -> Self

Create metadata that corresponds to a just-arrived message using the current system time.

Source

pub fn flags(&self) -> &Flags

Get the flags associated with this metadata.

Source

pub fn flags_mut(&mut self) -> &mut Flags

Get a mutable reference to the flags associated with this metadata.

Source

pub fn milestone_index(&self) -> Option<MilestoneIndex>

Get the milestone index of this message.

Source

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

Set the milestone index of this message.

Source

pub fn arrival_timestamp(&self) -> u64

Get the arrival timestamp (seconds from the unix epoch) of this message.

Source

pub fn solidification_timestamp(&self) -> u64

Get the solidification timestamp (seconds from the unix epoch) of this message.

Source

pub fn omrsi(&self) -> Option<IndexId>

Get the oldest message root snapshot index of this message.

Source

pub fn set_omrsi(&mut self, omrsi: IndexId)

Set the oldest message root snapshot index of this message.

Source

pub fn ymrsi(&self) -> Option<IndexId>

Get the youngest message root snapshot index of this message.

Source

pub fn set_ymrsi(&mut self, ymrsi: IndexId)

Set the youngest message root snapshot index of this message.

Source

pub fn reference_timestamp(&self) -> u64

Get the reference timestamp (seconds from the unix epoch) of this message.

Source

pub fn mark_solid(&mut self)

Mark this message as solid at the current system time.

Source

pub fn reference(&mut self, timestamp: u64)

Reference this message with the given timestamp.

Source

pub fn conflict(&self) -> ConflictReason

Get the conflict state of this message.

Source

pub fn set_conflict(&mut self, conflict: ConflictReason)

Set the conflict state of this message.

Trait Implementations§

Source§

impl Clone for MessageMetadata

Source§

fn clone(&self) -> MessageMetadata

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MessageMetadata

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MessageMetadata

Source§

fn default() -> MessageMetadata

Returns the “default value” for a type. Read more
Source§

impl Packable for MessageMetadata

Source§

type Error = MessageMetadataError

Associated error type.
Source§

fn packed_len(&self) -> usize

Returns the length of the packed bytes.
Source§

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

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

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.
Source§

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

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

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

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

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

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

impl PartialEq for MessageMetadata

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for MessageMetadata

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for MessageMetadata

Source§

impl Eq for MessageMetadata

Source§

impl StructuralPartialEq for MessageMetadata

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V