Enum Memo 

pub enum Memo {
    None,
    Text(String),
    Id(u64),
    Hash([u8; 32]),
    Return([u8; 32]),
}

Memo attached to transactions.

Variants

None

No memo

Text(String)

Text Memo

Id(u64)

Id Memo

Hash([u8; 32])

Hash Memo

Return([u8; 32])

Return Memo

Implementations

impl Memo

pub fn new_none() -> Memo

Create new empty memo.

pub fn new_id(id: u64) -> Memo

Create new id memo.

pub fn new_text<S: Into<String>>(text: S) -> Result<Memo>

Create new text memo. text must be shorter than 28 bytes.

pub fn new_hash(hash: &[u8]) -> Result<Memo>

Create new hash memo.

pub fn new_return(ret: &[u8]) -> Result<Memo>

Creates new return memo.

pub fn is_none(&self) -> bool

Returns true if memo is None. Returns false otherwise.

pub fn as_id(&self) -> Option<&u64>

If the memo is an Id, returns its value. Returns None otherwise.

pub fn as_id_mut(&mut self) -> Option<&mut u64>

If the memo is an Id, returns its mutable value. Returns None otherwise.

pub fn is_id(&self) -> bool

Returns true if memo is Id. Returns false otherwise.

pub fn as_text(&self) -> Option<&str>

If the memo is a Text, returns its value. Returns None otherwise.

pub fn as_text_mut(&mut self) -> Option<&mut str>

If the memo is a Text, returns its value. Returns None otherwise.

pub fn is_text(&self) -> bool

Returns true if memo is Text. Returns false otherwise.

pub fn as_hash(&self) -> Option<&[u8; 32]>

If the memo is a Hash, returns its value. Returns None otherwise.

pub fn as_hash_mut(&mut self) -> Option<&mut [u8; 32]>

If the memo is a Hash, returns its mutable value. Returns None otherwise.

pub fn is_hash(&self) -> bool

Returns true if memo is a Hash.

pub fn as_return(&self) -> Option<&[u8; 32]>

If the memo is a Return, returns its value. Returns None otherwise.

pub fn as_return_mut(&mut self) -> Option<&mut [u8; 32]>

If the memo is a Return, returns its mutable value. Returns None otherwise.

pub fn is_return(&self) -> bool

Returns true if memo is a Return.

pub fn to_xdr(&self) -> Result<Memo>

Returns the memo xdr object.

pub fn from_xdr(x: &Memo) -> Result<Memo>

Creates a new memo from the xdr object.

Trait Implementations

impl Clone for Memo

fn clone(&self) -> Memo

Returns a duplicate 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 PartialEq for Memo

fn eq(&self, other: &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 ReadXdr for Memo

fn read_xdr<R: Read>(r: &mut Limited<R>) -> Result<Self>

Read the XDR and construct the type.

fn read_xdr_to_end<R>(r: &mut Limited<R>) -> Result<Self, Error>

where R: Read,

Read the XDR and construct the type, and consider it an error if the read does not completely consume the read implementation.

fn read_xdr_into<R>(&mut self, r: &mut Limited<R>) -> Result<(), Error>

where R: Read,

Read the XDR and construct the type.

fn read_xdr_into_to_end<R>(&mut self, r: &mut Limited<R>) -> Result<(), Error>

where R: Read,

Read the XDR into the existing value, and consider it an error if the read does not completely consume the read implementation.

fn read_xdr_iter<R>(r: &mut Limited<R>) -> ReadXdrIter<&mut R, Self>

where R: Read,

Create an iterator that reads the read implementation as a stream of values that are read into the implementing type.

fn from_xdr(bytes: impl AsRef<[u8]>, limits: Limits) -> Result<Self, Error>

Construct the type from the XDR bytes.

impl WriteXdr for Memo

fn write_xdr<W: Write>(&self, w: &mut Limited<W>) -> Result<()>

fn to_xdr(&self, limits: Limits) -> Result<Vec<u8>, Error>

impl Eq for Memo

impl StructuralPartialEq for Memo