Enum crypto_addr::AddressOptions

#[non_exhaustive]
pub enum AddressOptions {
    Bitcoin,
    BitcoinCash(Option<String>),
    Litecoin,
    Dogecoin,
    Dash,
    BitcoinGold,
    Europecoin,
    Ripple,
    Peercoin,
}

Options 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

Bitcoin mainnet.

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

Litecoin mainnet.

Dogecoin

Dogecoin mainnet.

Dash

Dash mainnet.

BitcoinGold

Bitcoin Gold mainnet

Europecoin

Europecoin mainnet

Ripple

Ripple mainnet

Peercoin

Peercoin mainnet

Implementations

impl AddressOptions

pub fn address_prefix(&self) -> 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 AddressOptions

fn clone(&self) -> AddressOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AddressOptions

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

Formats the value using the given formatter.

impl Default for AddressOptions

fn default() -> AddressOptions

Returns the “default value” for a type.

impl Display for AddressOptions

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

Formats the value using the given formatter.

impl From<&AddressOptions> for WIFOptions

fn from(opts: &AddressOptions) -> Self

Obtain a WIFOptions using the same blockchain network as an AddressOptions

impl FromStr for AddressOptions

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl PartialEq<AddressOptions> for AddressOptions

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for AddressOptions

impl StructuralEq for AddressOptions

impl StructuralPartialEq for AddressOptions