Struct miden_objects::notes::NoteTag

pub struct NoteTag(/* private fields */);

Implementations

impl NoteTag

pub fn from_account_id( account_id: AccountId, execution: NoteExecutionMode ) -> Result<Self, NoteError>

Returns a new NoteTag instantiated from the specified account ID.

The tag is constructed as follows:

• For local execution, the two most significant bits are set to 0b00, the following 16 bits are set to the 16 most significant bits of the account ID, and the remaining 14 bits are set to 0.
• For network execution, the two most significant bits are set to 0b10 and the remaining bits are set to the 30 most significant bits of the account ID.

pub fn is_single_target(&self) -> bool

Returns true if the note is intended for execution by a specific account.

A note is intended for execution by a single account if either the first two bits are zeros or the first 3 bits are 0b100.

pub fn execution_mode(&self) -> NoteExecutionMode

Returns note execution mode defined by this tag.

If the most significant bit of the tag is 0 or the 3 most significant bits are equal to 0b101, the note is intended for local execution; otherwise, the note is intended for network execution.

pub fn inner(&self) -> u32

Returns the inner u32 value of this tag.

pub fn validate(&self, note_type: NoteType) -> Result<Self, NoteError>

Returns an error if this tag is not consistent with the specified note type, and self otherwise.

The tag and the note type are consistent if they satisfy the following rules:

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

Trait Implementations

impl Clone for NoteTag

fn clone(&self) -> NoteTag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NoteTag

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

Formats the value using the given formatter.

impl Deserializable for NoteTag

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 Display for NoteTag

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

Formats the value using the given formatter.

impl From<NoteTag> for Felt

fn from(value: NoteTag) -> Self

Converts to this type from the input type.

impl From<NoteTag> for u32

fn from(value: NoteTag) -> Self

Converts to this type from the input type.

impl From<NoteTag> for u64

fn from(value: NoteTag) -> Self

Converts to this type from the input type.

impl From<u32> for NoteTag

fn from(value: u32) -> Self

Converts to this type from the input type.

impl PartialEq for NoteTag

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

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 TryFrom<BaseElement> for NoteTag

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: Felt) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for NoteTag

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for NoteTag

impl Eq for NoteTag

impl StructuralPartialEq for NoteTag