Struct miden_client::notes::NoteMetadata

pub struct NoteMetadata { /* private fields */ }

Metadata associated with a note.

Note type and tag must be internally consistent according to the following rules:

• For off-chain notes, the most significant bit of the tag must be 0.
• For public notes, the second most significant bit of the tag must be 0.
• For encrypted notes, two most significant bits of the tag must be 00.

Implementations

impl NoteMetadata

pub fn new( sender: AccountId, note_type: NoteType, tag: NoteTag, aux: BaseElement, ) -> Result<NoteMetadata, NoteError>

Returns a new NoteMetadata instantiated with the specified parameters.

Errors

Returns an error if the note type and note tag are inconsistent.

pub fn sender(&self) -> AccountId

Returns the account which created the note.

pub fn note_type(&self) -> NoteType

Returns the note’s type.

pub fn tag(&self) -> NoteTag

Returns the tag associated with the note.

pub fn aux(&self) -> BaseElement

Returns the note’s aux field.

pub fn is_offchain(&self) -> bool

Returns true if the note is off-chain.

Trait Implementations

impl Clone for NoteMetadata

fn clone(&self) -> NoteMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NoteMetadata

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

Formats the value using the given formatter.

impl Deserializable for NoteMetadata

fn read_from<R>(source: &mut R) -> Result<NoteMetadata, 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<'de> Deserialize<'de> for NoteMetadata

fn deserialize<__D>( __deserializer: __D, ) -> Result<NoteMetadata, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&NoteMetadata> for [BaseElement; 4]

fn from(metadata: &NoteMetadata) -> [BaseElement; 4]

Converts to this type from the input type.

impl From<NoteMetadata> for [BaseElement; 4]

fn from(metadata: NoteMetadata) -> [BaseElement; 4]

Converts to this type from the input type.

impl PartialEq for NoteMetadata

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

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 Serialize for NoteMetadata

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<[BaseElement; 4]> for NoteMetadata

type Error = NoteError

The type returned in the event of a conversion error.

fn try_from( elements: [BaseElement; 4], ) -> Result<NoteMetadata, <NoteMetadata as TryFrom<[BaseElement; 4]>>::Error>

Performs the conversion.

impl Copy for NoteMetadata

impl Eq for NoteMetadata

impl StructuralPartialEq for NoteMetadata