Enum miden_client::transactions::OutputNote

pub enum OutputNote {
    Full(Note),
    Partial(PartialNote),
    Header(NoteHeader),
}

The types of note outputs supported by the transaction kernel.

Variants

Full(Note)

Partial(PartialNote)

Header(NoteHeader)

Implementations

impl OutputNote

pub fn assets(&self) -> Option<&NoteAssets>

The assets contained in the note.

pub fn id(&self) -> NoteId

Unique note identifier.

This value is both an unique identifier and a commitment to the note.

pub fn recipient_digest(&self) -> Option<RpoDigest>

Value that represents under which condition a note can be consumed.

See crate::notes::NoteRecipient for more details.

pub fn metadata(&self) -> &NoteMetadata

Note’s metadata.

pub fn shrink(&self) -> OutputNote

Erase private note information.

Specifically:

• Full private notes are converted into note headers.
• All partial notes are converted into note headers.

pub fn hash(&self) -> RpoDigest

Returns a commitment to the note and its metadata.

hash(NOTE_ID || NOTE_METADATA)

Trait Implementations

impl Clone for OutputNote

fn clone(&self) -> OutputNote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OutputNote

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

Formats the value using the given formatter.

impl Deserializable for OutputNote

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

where R: ByteReader,

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 PartialEq for OutputNote

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

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

where W: ByteWriter,

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<OutputNote> for OutputNoteRecord

OutputNote can always be turned into an OutputNoteRecord when they’re either OutputNote::Full or OutputNote::Partial and always fail the conversion if it’s OutputNote::Header. This also mean that output_note.try_from() can also be used as a way to filter the full and partial output notes

type Error = ClientError

The type returned in the event of a conversion error.

fn try_from(output_note: OutputNote) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for OutputNote

impl StructuralPartialEq for OutputNote