Enum NoteAttachmentContent 

pub enum NoteAttachmentContent {
    None,
    Word(Word),
    Array(NoteAttachmentArray),
}

The content of a NoteAttachment.

If a note attachment is not required, NoteAttachmentContent::None should be used.

When a single Word has sufficient space, NoteAttachmentContent::Word should be used, as it does not require any hashing. The word itself is encoded into the NoteMetadata.

If the space of a Word is insufficient, the more flexible NoteAttachmentContent::Array variant can be used. It contains a set of field elements where only their sequential hash is encoded into the NoteMetadata.

Variants

None

Signals the absence of a note attachment.

Word(Word)

A note attachment consisting of a single Word.

Array(NoteAttachmentArray)

A note attachment consisting of the commitment to a set of felts.

Implementations

impl NoteAttachmentContent

pub fn empty_word() -> Self

Creates a new NoteAttachmentContent::Word containing an empty word.

pub fn new_word(word: Word) -> Self

Creates a new NoteAttachmentContent::Word from the provided word.

pub fn new_array(elements: Vec<Felt>) -> Result<Self, NoteError>

Creates a new NoteAttachmentContent::Array from the provided elements.

Errors

Returns an error if:

• The maximum number of elements exceeds NoteAttachmentArray::MAX_NUM_ELEMENTS.

pub fn attachment_kind(&self) -> NoteAttachmentKind

Returns the NoteAttachmentKind.

pub fn to_word(&self) -> Word

Returns the NoteAttachmentContent encoded to a Word.

See the type-level documentation for more details.

Trait Implementations

impl Clone for NoteAttachmentContent

fn clone(&self) -> NoteAttachmentContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NoteAttachmentContent

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

Formats the value using the given formatter.

impl Default for NoteAttachmentContent

fn default() -> NoteAttachmentContent

Returns the “default value” for a type.

impl Deserializable for NoteAttachmentContent

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<NoteAttachmentArray> for NoteAttachmentContent

fn from(array: NoteAttachmentArray) -> Self

Converts to this type from the input type.

impl PartialEq for NoteAttachmentContent

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

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 Eq for NoteAttachmentContent

impl StructuralPartialEq for NoteAttachmentContent