Struct miden_objects::transaction::OutputNotes

pub struct OutputNotes<T: ToEnvelope = OutputNote> { /* private fields */ }

Contains a list of output notes of a transaction. The list can be empty if the transaction does not produce any notes.

For the purposes of this struct, anything that can be reduced to a note envelope can be an output note. However, ToEnvelope trait is currently implemented only for OutputNote and NoteEnvelope, and so these are the only two allowed output note types.

Implementations

impl<T: ToEnvelope> OutputNotes<T>

pub fn new(notes: Vec<T>) -> Result<Self, TransactionOutputError>

Returns new OutputNotes instantiated from the provide vector of notes.

Errors

Returns an error if:

• The total number of notes is greater than 1024.
• The vector of notes contains duplicates.

pub fn commitment(&self) -> Digest

Returns the commitment to the output notes.

The commitment is computed as a sequential hash of (hash, metadata) tuples for the notes created in a transaction.

pub fn num_notes(&self) -> usize

Returns total number of output notes.

pub fn is_empty(&self) -> bool

Returns true if this OutputNotes does not contain any notes.

pub fn get_note(&self, idx: usize) -> &T

Returns a reference to the note located at the specified index.

pub fn iter(&self) -> impl Iterator<Item = &T>

Returns an iterator over notes in this OutputNotes.

Trait Implementations

impl<T: Clone + ToEnvelope> Clone for OutputNotes<T>

fn clone(&self) -> OutputNotes<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ToEnvelope> Debug for OutputNotes<T>

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

Formats the value using the given formatter.

impl Default for OutputNotes

fn default() -> Self

Returns the “default value” for a type.

impl<T: ToEnvelope> Deserializable for OutputNotes<T>

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

fn from(notes: OutputNotes) -> Self

Converts to this type from the input type.

impl<T: ToEnvelope> IntoIterator for OutputNotes<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<<OutputNotes<T> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: ToEnvelope> PartialEq for OutputNotes<T>

fn eq(&self, other: &Self) -> 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<T: ToEnvelope> Serializable for OutputNotes<T>

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<T: ToEnvelope> Eq for OutputNotes<T>