Struct MemoBytes

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

The unencrypted memo bytes received alongside a shielded note in a Zcash transaction.

Implementations

impl MemoBytes

pub fn empty() -> MemoBytes

Creates a MemoBytes indicating that no memo is present.

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

Creates a MemoBytes from a slice, exactly as provided.

Returns an error if the provided slice is longer than 512 bytes. Slices shorter than 512 bytes are padded with null bytes.

Note that passing an empty slice to this API (or an all-zeroes slice) will result in a memo representing an empty string. What you almost certainly want in this case is MemoBytes::empty, which uses a specific encoding to indicate that no memo is present.

pub fn as_array(&self) -> &[u8; 512]

Returns the raw byte array containing the memo bytes, including null padding.

pub fn into_bytes(self) -> [u8; 512]

Consumes this MemoBytes value and returns the underlying byte array.

pub fn as_slice(&self) -> &[u8]

Returns a slice of the raw bytes, excluding null padding.

Trait Implementations

impl Clone for MemoBytes

fn clone(&self) -> MemoBytes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoBytes

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

Formats the value using the given formatter.

impl From<&Memo> for MemoBytes

fn from(memo: &Memo) -> MemoBytes

Serializes the Memo per ZIP 302.

impl From<Memo> for MemoBytes

fn from(memo: Memo) -> MemoBytes

Serializes the Memo per ZIP 302.

impl Ord for MemoBytes

fn cmp(&self, rhs: &MemoBytes) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MemoBytes

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

fn partial_cmp(&self, other: &MemoBytes) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&MemoBytes> for Memo

fn try_from( bytes: &MemoBytes, ) -> Result<Memo, <Memo as TryFrom<&MemoBytes>>::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<Memo, <Memo as TryFrom<MemoBytes>>::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 Eq for MemoBytes