Enum Memo

pub enum Memo {
    Empty,
    Text(TextMemo),
    Future(MemoBytes),
    Arbitrary(Box<[u8; 511]>),
}

An unencrypted memo received alongside a shielded note in a Zcash transaction.

Variants

Empty

An empty memo field.

Text(TextMemo)

A memo field containing a UTF-8 string.

Future(MemoBytes)

Some unknown memo format from ✨the future✨ that we can’t parse.

Arbitrary(Box<[u8; 511]>)

A memo field containing arbitrary bytes.

Implementations

impl Memo

pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error>

Parses a Memo from its ZIP 302 serialization.

Returns an error if the provided slice does not represent a valid Memo (for example, if the slice is not 512 bytes, or the encoded Memo is non-canonical).

pub fn encode(&self) -> MemoBytes

Serializes the Memo per ZIP 302.

Trait Implementations

impl Clone for Memo

fn clone(&self) -> Memo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Memo

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

Formats the value using the given formatter.

impl Default for Memo

fn default() -> Memo

Returns the “default value” for a type.

impl From<&Memo> for MemoBytes

fn from(memo: &Memo) -> Self

Serializes the Memo per ZIP 302.

impl From<Memo> for MemoBytes

fn from(memo: Memo) -> Self

Serializes the Memo per ZIP 302.

impl FromStr for Memo

fn from_str(memo: &str) -> Result<Self, Self::Err>

Returns a Memo containing the given string, or an error if the string is too long.

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for Memo

fn eq(&self, rhs: &Memo) -> 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 TryFrom<&MemoBytes> for Memo

fn try_from(bytes: &MemoBytes) -> Result<Self, Self::Error>

Parses a Memo from its ZIP 302 serialization.

Returns an error if the provided slice does not represent a valid Memo (for example, if the slice is not 512 bytes, or the encoded Memo is non-canonical).

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<MemoBytes> for Memo

fn try_from(bytes: MemoBytes) -> Result<Self, Self::Error>

Parses a Memo from its ZIP 302 serialization.

Returns an error if the provided slice does not represent a valid Memo (for example, if the slice is not 512 bytes, or the encoded Memo is non-canonical).

type Error = Error

The type returned in the event of a conversion error.