Struct NoteMetadata 

pub struct NoteMetadata {
    pub sender: Option<AccountId>,
    pub note_type: i32,
    pub tag: u32,
    pub attachment_schemes: Vec<u32>,
    pub attachments_commitment: Option<Digest>,
}

Represents a note’s metadata.

Mirrors the protocol-level miden_protocol::note::NoteMetadata: it carries the partial metadata (sender, note type, tag), the per-slot attachment schemes, and the commitment over the note’s attachments. The full attachment contents (when present) are carried separately on Note / NetworkNote.

Fields

sender: Option<AccountId>

The account which sent the note.

note_type: i32

The type of the note.

tag: u32

A value which can be used by the recipient(s) to identify notes intended for them.

See miden_protocol::note::note_tag for more info.

attachment_schemes: Vec<u32>

The attachment scheme of each attachment slot.

The protocol allows up to NoteAttachments::MAX_COUNT attachments per note. Each slot carries either a scheme value in 1..=65534 or 0 to indicate that the slot is absent. Trailing absent slots may be omitted, so a note with no attachments has an empty list.

See miden_protocol::note::NoteAttachmentHeader for more info.

attachments_commitment: Option<Digest>

Commitment over the note’s attachments.

See miden_protocol::note::NoteAttachments::to_commitment for more info.

Implementations

impl NoteMetadata

pub fn note_type(&self) -> NoteType

Returns the enum value of note_type, or the default if the field is set to an invalid enum value.

pub fn set_note_type(&mut self, value: NoteType)

Sets note_type to the provided enum value.

Trait Implementations

impl Clone for NoteMetadata

fn clone(&self) -> NoteMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NoteMetadata

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

Formats the value using the given formatter.

impl Default for NoteMetadata

fn default() -> Self

Returns the “default value” for a type.

impl Eq for NoteMetadata

impl From<NoteMetadata> for NoteMetadata

fn from(val: NoteMetadata) -> Self

Converts to this type from the input type.

impl Hash for NoteMetadata

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 Message for NoteMetadata

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

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

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for NoteMetadata

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

impl TryFrom<NoteMetadata> for NoteMetadata

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: NoteMetadata) -> Result<Self, Self::Error>

Performs the conversion.