Struct bee_tangle::metadata::MessageMetadata

pub struct MessageMetadata { /* fields omitted */ }

Metadata associated with a tangle message.

Implementations

impl MessageMetadata

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.

pub fn arrived() -> Self

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

pub fn flags(&self) -> &Flags

Get the flags associated with this metadata.

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

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

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

Get the milestone index of this message.

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

Set the milestone index of this message.

pub fn arrival_timestamp(&self) -> u64

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

pub fn solidification_timestamp(&self) -> u64

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

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

Get the oldest message root snapshot index of this message.

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

Set the oldest message root snapshot index of this message.

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

Get the youngest message root snapshot index of this message.

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

Set the youngest message root snapshot index of this message.

pub fn reference_timestamp(&self) -> u64

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

pub fn mark_solid(&mut self)

Mark this message as solid at the current system time.

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

Reference this message with the given timestamp.

pub fn conflict(&self) -> ConflictReason

Get the conflict state of this message.

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

Set the conflict state of this message.

Trait Implementations

impl Clone for MessageMetadata

fn clone(&self) -> MessageMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MessageMetadata

impl Debug for MessageMetadata

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

Formats the value using the given formatter.

impl Default for MessageMetadata

fn default() -> MessageMetadata

Returns the “default value” for a type.

impl<B: StorageBackend> Hooks<MessageMetadata> for StorageHooks<B>

type Error = B::Error

An error generated by these hooks.

fn get<'life0, 'life1, 'async_trait>(
    &'life0 self,
    id: &'life1 MessageId
) -> Pin<Box<dyn Future<Output = Result<Option<(Message, MessageMetadata)>, Self::Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Fetch a message from some external storage medium.

fn insert<'life0, 'async_trait>(
    &'life0 self,
    id: MessageId,
    tx: Message,
    metadata: MessageMetadata
) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Insert a message into some external storage medium.

fn fetch_approvers<'life0, 'life1, 'async_trait>(
    &'life0 self,
    id: &'life1 MessageId
) -> Pin<Box<dyn Future<Output = Result<Option<Vec<MessageId>>, Self::Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Fetch the approvers list for a given message.

fn insert_approver<'life0, 'async_trait>(
    &'life0 self,
    id: MessageId,
    approver: MessageId
) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Insert a new approver for a given message.

fn update_approvers<'life0, 'life1, 'async_trait>(
    &'life0 self,
    id: MessageId,
    approvers: &'life1 [MessageId]
) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Update the approvers list for a given message.

impl Packable for MessageMetadata

type Error = MessageMetadataError

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 Serialize for MessageMetadata

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

Serialize this value into the given Serde serializer.