Struct miden_objects::notes::NoteMetadata

pub struct NoteMetadata { /* private fields */ }

Represents metadata associated with a note.

The metadata consists of:

• sender is the account which created the note.
• tag is a value which can be used by the recipient(s) to identify notes intended for them.

Implementations

impl NoteMetadata

pub fn new(sender: AccountId, tag: Felt) -> Self

Returns a new NoteMetadata instantiated with the specified parameters.

pub fn sender(&self) -> AccountId

Returns the account which created the note.

pub fn tag(&self) -> Felt

Returns the tag associated with the note.

Trait Implementations

impl Clone for NoteMetadata

fn clone(&self) -> NoteMetadata

Returns a copy 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 Deserializable for NoteMetadata

fn read_from<R: ByteReader>( source: &mut R ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl From<&NoteMetadata> for Word

fn from(metadata: &NoteMetadata) -> Self

Converts to this type from the input type.

impl From<NoteMetadata> for Word

fn from(metadata: NoteMetadata) -> Self

Converts to this type from the input type.

impl PartialEq for NoteMetadata

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serializable for NoteMetadata

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

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

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl TryFrom<[BaseElement; 4]> for NoteMetadata

type Error = NoteError

The type returned in the event of a conversion error.

fn try_from(elements: Word) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for NoteMetadata

impl Eq for NoteMetadata

impl StructuralPartialEq for NoteMetadata