Struct OutputNoteCollection 

pub struct OutputNoteCollection<N> { /* private fields */ }

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

This struct is generic over the note type N, allowing it to be used with both RawOutputNote (in ExecutedTransaction) and OutputNote (in ProvenTransaction).

Implementations

impl<N> OutputNoteCollection<N>

where for<'a> &'a NoteHeader: From<&'a N>, for<'a> NoteId: From<&'a N>,

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

Returns new OutputNoteCollection instantiated from the provided vector of notes.

Errors

Returns an error if:

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

pub fn commitment(&self) -> Word

Returns the commitment to the output notes.

The commitment is computed as a sequential hash of (note_details_commitment, metadata_commitment) 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 OutputNoteCollection does not contain any notes.

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

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

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

Returns an iterator over notes in this OutputNoteCollection.

Trait Implementations

impl<N: Clone> Clone for OutputNoteCollection<N>

fn clone(&self) -> OutputNoteCollection<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Debug> Debug for OutputNoteCollection<N>

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

Formats the value using the given formatter.

impl<N> Deserializable for OutputNoteCollection<N>

where N: Deserializable, for<'a> &'a NoteHeader: From<&'a N>, for<'a> NoteId: From<&'a N>,

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 min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

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

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

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

Deserializes Self from bytes with a byte budget limit.

impl<N> IntoIterator for OutputNoteCollection<N>

type Item = N

The type of the elements being iterated over.

type IntoIter = IntoIter<N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<N: PartialEq> PartialEq for OutputNoteCollection<N>

fn eq(&self, other: &OutputNoteCollection<N>) -> 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<N: Serializable> Serializable for OutputNoteCollection<N>

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<N: Eq> Eq for OutputNoteCollection<N>

impl<N> StructuralPartialEq for OutputNoteCollection<N>