Enum AddressFormat

#[non_exhaustive]
pub enum AddressFormat {
    Bitcoin(BitcoinFormat),
    BitcoinTestnet,
    Ethereum,
    BitcoinCash(Option<String>),
    Litecoin,
    LitecoinCash,
    Dogecoin,
    Dash,
    Ripple,
    Namecoin,
    Asiacoin,
    BitcoinGold,
    Beetlecoin,
    Blackcoin,
    Clams,
    Europecoin,
    Feathercoin,
    Fujicoin,
    Hempcoin,
    Peercoin,
    Potcoin,
    ShadowCash,
    Stratis,
    Syscoin,
    VCash,
    Verge,
    Vertcoin,
    ZCash,
}

Format specification for generating addresses from public keys.

Specifies how a public key should be formatted into an address. Unit-like variants merely specify the blockchain network for which the address is intended to be used. No further information is needed for unit-like variants because this crate only supports one way to format the public key into an address string for that blockchain network.

Non-unit-like variants specify a blockchain network, but also contain additional user options that further specify how the address should be formatted.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bitcoin(BitcoinFormat)

Bitcoin mainnet.

BitcoinTestnet

Ethereum

Available on crate feature eth only.

BitcoinCash(Option<String>)

Bitcoin cash mainnet. Inner value is the human-readable prefix to use in the address. If it is Some, the contained String will be used as the prefix to calculate with the cashaddr string with and it will be included in the cashaddr. If it is None, "bitcoincash" will be used as the prefix, but it will be omitted from the cashaddr as it is implied.

Litecoin

LitecoinCash

Dogecoin

Dash

Ripple

Namecoin

Asiacoin

BitcoinGold

Beetlecoin

Blackcoin

Clams

Europecoin

Feathercoin

Fujicoin

Hempcoin

Peercoin

Potcoin

ShadowCash

Stratis

Syscoin

VCash

Verge

Vertcoin

ZCash

Implementations

impl AddressFormat

pub fn address_prefix(&self) -> Option<u8>

get the address’s prefix byte if it exists

pub fn network_name(&self) -> String

Get the name of the network associated with these options

pub fn length(&self) -> usize

Get the maximum string length of the address generated for the given address options. This is useful for formatting.

Trait Implementations

impl Clone for AddressFormat

fn clone(&self) -> AddressFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddressFormat

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

Formats the value using the given formatter.

impl Default for AddressFormat

fn default() -> Self

Returns the “default value” for a type.

impl Display for AddressFormat

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

Write the name of the blockchain network this AddressFormat is associated with

impl From<&AddressFormat> for WIFFormat

fn from(opts: &AddressFormat) -> Self

Obtain a WIFFormat using the same blockchain network as an AddressFormat

impl FromStr for AddressFormat

fn from_str(s: &str) -> Result<Self, Error>

Parse a string s to return an AddressFormat instance. s must be either the common ticker symbol which represents the cryptocurrency or the name of the blockchain network. Parsing is case-insensitive: e.g. "btc", "bitcoin", "BTC", and "Bitcoin" all parse to Bitcoin, "ltc" and "litecoin" parse to Litecoin, etc.

In the case of Bitcoin Cash addresses, the optional human-readable prefix can be specified after a :, e.g. "bch" parses to BitcoinCash(None) and "bch:hrpref parses to BitcoinCash(Some(String::from("hrpref")))

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for AddressFormat

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

Tests for self and other values to be equal, and is used by ==.

const 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 AddressFormat

impl StructuralPartialEq for AddressFormat