Struct NoteAttachments 

pub struct NoteAttachments { /* private fields */ }

A collection of note attachments.

Notes can have up to Self::MAX_COUNT attachments.

The commitment to the attachments is defined as:

• 0 attachments: EMPTY_WORD
• 1+ attachments: hash(ATTACHMENT_0_COMMITMENT || ... || ATTACHMENT_N_COMMITMENT), i.e., the sequential hash over the individual attachment commitments.

Implementations

impl NoteAttachments

pub const MAX_COUNT: usize = 4

The maximum number of attachments per note.

pub const MAX_NUM_WORDS: u16 = 512

The maximum total number of elements across all attachments in a note.

Each element holds roughly 8 bytes of data and so this allows for a maximum of 512 * 32 = 2^14 = 16384 bytes.

pub fn empty() -> Self

Creates a new empty NoteAttachments collection.

pub fn new(attachments: Vec<NoteAttachment>) -> Result<Self, NoteError>

Creates a NoteAttachments from a vector of attachments.

Errors

Returns an error if:

• The number of attachments exceeds Self::MAX_COUNT.
• The total number of words across all attachments exceeds Self::MAX_NUM_WORDS.

pub fn get(&self, index: usize) -> Option<&NoteAttachment>

Returns the attachment at the given index, if it exists.

pub fn find(&self, scheme: NoteAttachmentScheme) -> Option<&NoteAttachment>

Returns the first attachment with the provided scheme, if any.

pub fn num_attachments(&self) -> u8

Returns the number of attachments.

pub fn is_empty(&self) -> bool

Returns true if there are no attachments.

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

Returns an iterator over the attachments.

pub fn commitments(&self) -> Vec<Word>

Returns the individual commitment of each contained attachment.

pub fn to_commitment(&self) -> Word

Returns the commitment over the contained attachments.

pub fn to_headers(&self) -> [NoteAttachmentHeader; 4]

Returns the attachment headers for all attachment slots.

Returns a fixed-size array of Self::MAX_COUNT headers. Unused slots are filled with NoteAttachmentHeader::absent.

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

Consumes self and returns the inner vector of attachments.

Trait Implementations

impl Clone for NoteAttachments

fn clone(&self) -> NoteAttachments

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NoteAttachments

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

Formats the value using the given formatter.

impl Default for NoteAttachments

fn default() -> Self

Returns the “default value” for a type.

impl Deserializable for NoteAttachments

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 From<NoteAttachment> for NoteAttachments

fn from(attachment: NoteAttachment) -> Self

Converts to this type from the input type.

impl PartialEq for NoteAttachments

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

fn to_elements(&self) -> Vec<Felt>

Collects all attachment commitments into a flat vector of field elements.

type Commitment = Word

A type of the commitment which must be derivable from Word.

fn to_commitment(&self) -> Self::Commitment

Computes the commitment to the object.

impl Serializable for NoteAttachments

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

Serializes self into bytes and writes these bytes into the target.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

impl Eq for NoteAttachments

impl StructuralPartialEq for NoteAttachments