Struct NoteStorage 

pub struct NoteStorage { /* private fields */ }

A container for note storage items.

A note can be associated with up to 1024 storage items. Each item is represented by a single field element. Thus, note storage can contain up to ~8 KB of data.

All storage items associated with a note can be reduced to a single commitment which is computed as an RPO256 hash over the storage elements.

Implementations

impl NoteStorage

pub fn new(items: Vec<BaseElement>) -> Result<NoteStorage, NoteError>

Returns NoteStorage instantiated from the provided items.

Errors

Returns an error if the number of provided storage items is greater than 1024.

pub fn commitment(&self) -> Word

Returns a commitment to this storage.

pub fn num_items(&self) -> u16

Returns the number of storage items.

The returned value is guaranteed to be smaller than or equal to MAX_NOTE_STORAGE_ITEMS.

pub fn is_empty(&self) -> bool

Returns true if the storage has no items.

pub fn items(&self) -> &[BaseElement]

Returns a reference to the storage items.

pub fn to_elements(&self) -> Vec<BaseElement>

Returns the note’s storage as a vector of field elements.

Trait Implementations

impl Clone for NoteStorage

fn clone(&self) -> NoteStorage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NoteStorage

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

Formats the value using the given formatter.

impl Default for NoteStorage

fn default() -> NoteStorage

Returns the “default value” for a type.

impl Deserializable for NoteStorage

fn read_from<R>(source: &mut R) -> Result<NoteStorage, DeserializationError>

where R: ByteReader,

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<MintNoteStorage> for NoteStorage

fn from(mint_storage: MintNoteStorage) -> NoteStorage

Converts to this type from the input type.

impl From<NoteStorage> for Vec<BaseElement>

fn from(value: NoteStorage) -> Vec<BaseElement>

Converts to this type from the input type.

impl From<P2idNoteStorage> for NoteStorage

fn from(storage: P2idNoteStorage) -> NoteStorage

Converts to this type from the input type.

impl From<P2ideNoteStorage> for NoteStorage

fn from(storage: P2ideNoteStorage) -> NoteStorage

Converts to this type from the input type.

impl PartialEq for NoteStorage

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

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

where W: ByteWriter,

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 TryFrom<Vec<BaseElement>> for NoteStorage

type Error = NoteError

The type returned in the event of a conversion error.

fn try_from( value: Vec<BaseElement>, ) -> Result<NoteStorage, <NoteStorage as TryFrom<Vec<BaseElement>>>::Error>

Performs the conversion.

impl Eq for NoteStorage