Struct miden_objects::transaction::InputNotes

pub struct InputNotes<T: ToNullifier = InputNote> { /* private fields */ }

Contains a list of input notes for a transaction. The list can be empty if the transaction does not consume any notes.

For the purposes of this struct, anything that can be reduced to a Nullifier can be an input note. However, ToNullifier trait is currently implemented only for InputNote and Nullifier, and so these are the only two allowed input note types.

Implementations

impl<T: ToNullifier> InputNotes<T>

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

Returns new InputNotes instantiated from the provided 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 a commitment to these input notes.

pub fn num_notes(&self) -> usize

Returns total number of input notes.

pub fn is_empty(&self) -> bool

Returns true if this InputNotes 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 InputNotes.

pub fn into_vec(self) -> Vec<T>

Converts self into a vector of input notes.

Trait Implementations

impl<T: Clone + ToNullifier> Clone for InputNotes<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ToNullifier> Debug for InputNotes<T>

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

Formats the value using the given formatter.

impl<T: ToNullifier> Default for InputNotes<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ToNullifier> Deserializable for InputNotes<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<&InputNotes> for InputNotes<Nullifier>

fn from(value: &InputNotes) -> Self

Converts to this type from the input type.

impl From<InputNotes> for InputNotes<Nullifier>

fn from(value: InputNotes) -> Self

Converts to this type from the input type.

impl<T: ToNullifier> IntoIterator for InputNotes<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<<InputNotes<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: ToNullifier> PartialEq for InputNotes<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: ToNullifier> Serializable for InputNotes<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: ToNullifier> Eq for InputNotes<T>