Struct earth_codec::Address

pub struct Address {
    pub body: Vec<u8>,
    pub scheme: Scheme,
    pub hash_type: HashType,
    pub network: Network,
}

Struct containing the bytes and metadata of a Bitcoin Cash address. This is yeilded during decoding or consumed during encoding.

Fields

body: Vec<u8>

Address bytes

scheme: Scheme

Encoding scheme

hash_type: HashType

Hash type

network: Network

Network

Methods

impl Address

pub fn new(
    body: Vec<u8>,
    scheme: Scheme,
    hash_type: HashType,
    network: Network
) -> Self

Create a new address

pub fn into_body(self) -> Vec<u8>

Take address bytes

pub fn encode(&self) -> Result<String, AddressError>

Attempt to convert the raw address bytes to a string

pub fn decode(
    addr_str: &str
) -> Result<Self, (CashAddrError, EarthError, Base58Error)>

Attempt to convert an address string into bytes

Trait Implementations

impl<'a> AsRef<[u8]> for Address

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Clone for Address

fn clone(&self) -> Address

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Address

Creates an empty Address struct, with the body bytes the empty vector, Scheme::Earth, HashType::Key, and Network::Main.

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<Address> for Address

fn eq(&self, other: &Address) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Address) -> bool

This method tests for !=.

impl Debug for Address

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

Formats the value using the given formatter.

impl StructuralPartialEq for Address