Enum ShieldedMemo 

pub enum ShieldedMemo {
    Empty,
    Text(String),
    Other {
        kind: u32,
        payload: [u8; 32],
    },
}

A decoded shielded note memo.

to_bytes/from_bytes are exact inverses for every variant: a memo written by to_bytes decodes back to an equal value, and any 36 bytes decode to some variant (unknown kinds and malformed text fall back to Self::Other), so decoding is total and never loses bytes.

Variants

Empty

No memo: the all-zero 36 bytes. Today’s [0u8; 36] memos decode to this.

Text(String)

A UTF-8 text memo whose byte length is at most MEMO_PAYLOAD_SIZE.

Other

Any memo whose kind this version does not interpret (or a structurally-invalid known kind). Retained verbatim so it round-trips unchanged.

Fields

kind: u32

The raw 4-byte kind tag.

payload: [u8; 32]

The raw 32-byte payload.

Implementations

impl ShieldedMemo

pub fn text(s: impl Into<String>) -> Result<Self, ProtocolError>

Build a text memo, validating that s is at most MEMO_PAYLOAD_SIZE bytes when UTF-8 encoded.

pub fn to_bytes(&self) -> [u8; 36]

Encode to the on-chain 36-byte memo layout.

pub fn from_bytes(bytes: &[u8; 36]) -> Self

Decode from the on-chain 36-byte memo layout.

Decoding is total: a KIND_TEXT memo whose payload is not valid UTF-8, or a KIND_EMPTY memo with a non-zero payload, falls back to Self::Other so the raw bytes are preserved rather than lost.

Trait Implementations

impl Clone for ShieldedMemo

fn clone(&self) -> ShieldedMemo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShieldedMemo

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

Formats the value using the given formatter.

impl PartialEq for ShieldedMemo

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

impl StructuralPartialEq for ShieldedMemo