Struct miden_objects::notes::NoteEnvelope

pub struct NoteEnvelope { /* private fields */ }

Holds information that is relevant to the recipient of a note.

Contains:

• note_id: ID of the note that was created
• note_metadata: metadata of the note that was created. Metadata is padded with ZERO such that it is four elements in size (a word). The metadata includes the following elements:
  • sender
  • tag
  • num assets
  • ZERO

Implementations

impl NoteEnvelope

pub fn new(note_id: NoteId, note_metadata: NoteMetadata) -> Self

Creates a new NoteEnvelope object.

pub fn note_id(&self) -> NoteId

Returns a unique identifier of the note that was created.

pub fn metadata(&self) -> &NoteMetadata

Returns the metadata of the note that was created.

Trait Implementations

impl Clone for NoteEnvelope

fn clone(&self) -> NoteEnvelope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NoteEnvelope

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

Formats the value using the given formatter.

impl Deserializable for NoteEnvelope

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<&Note> for NoteEnvelope

fn from(note: &Note) -> Self

Converts to this type from the input type.

impl From<&NoteEnvelope> for [Word; 2]

fn from(note_envelope: &NoteEnvelope) -> Self

Converts to this type from the input type.

impl From<&NoteEnvelope> for [Felt; 8]

fn from(note_envelope: &NoteEnvelope) -> Self

Converts to this type from the input type.

impl From<&NoteEnvelope> for [u8; 64]

fn from(note_envelope: &NoteEnvelope) -> Self

Converts to this type from the input type.

impl From<&OutputNote> for NoteEnvelope

fn from(note_stub: &OutputNote) -> Self

Converts to this type from the input type.

impl From<Note> for NoteEnvelope

fn from(note: Note) -> Self

Converts to this type from the input type.

impl From<NoteEnvelope> for [Word; 2]

fn from(note_envelope: NoteEnvelope) -> Self

Converts to this type from the input type.

impl From<NoteEnvelope> for [Felt; 8]

fn from(note_envelope: NoteEnvelope) -> Self

Converts to this type from the input type.

impl From<NoteEnvelope> for [u8; 64]

fn from(note_envelope: NoteEnvelope) -> Self

Converts to this type from the input type.

impl From<OutputNote> for NoteEnvelope

fn from(note_stub: OutputNote) -> Self

Converts to this type from the input type.

impl PartialEq for NoteEnvelope

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

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 ToEnvelope for NoteEnvelope

fn id(&self) -> NoteId

fn metadata(&self) -> NoteMetadata

fn to_envelope(&self) -> NoteEnvelope

impl Copy for NoteEnvelope

impl Eq for NoteEnvelope

impl StructuralPartialEq for NoteEnvelope