Enum SparkNetwork

#[non_exhaustive]
pub enum SparkNetwork {
    Mainnet,
    Regtest,
}

Spark Network. This is the network of the Spark Operators that the user chooses to connect to.

• Mainnet is the Bitcoin network, and all operations involve real money.
• Regtest is Lightspark’s Regtest network for testing purposes.

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.

Mainnet

Mainnet Bitcoin network. Use this for real transactions with actual value.

Regtest

Lightspark’s Regtest network for testing and development. No real value is transferred when using this network.

Implementations

impl SparkNetwork

pub fn to_bitcoin_network(&self) -> Network

Converts a Spark network to its corresponding Bitcoin network.

Returns

The equivalent Bitcoin network type from the bitcoin crate:

• SparkNetwork::Mainnet returns bitcoin::Network::Bitcoin
• SparkNetwork::Regtest returns bitcoin::Network::Regtest

pub fn marshal_proto(&self) -> i32

Marshals the network type to its protocol buffer representation. For most use cases, you don’t need to use this method.

Returns

An integer representing the network in the protocol buffer format.

Trait Implementations

impl Clone for SparkNetwork

fn clone(&self) -> SparkNetwork

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SparkNetwork

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

Formats the value using the given formatter.

impl Display for SparkNetwork

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

Formats the network as a lowercase string.

Returns

• "mainnet" for SparkNetwork::Mainnet
• "regtest" for SparkNetwork::Regtest

impl FromStr for SparkNetwork

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

Creates a SparkNetwork from a string representation.

The string comparison is case-insensitive, so both “mainnet” and “Mainnet” will return SparkNetwork::Mainnet.

Arguments

• s - A string slice representing the network (“mainnet” or “regtest”)

Returns

• Ok(SparkNetwork) if the string matches a known network
• Err(String) with an error message if the string does not match

Examples

use std::str::FromStr;
use spark_rust::SparkNetwork;

let mainnet = SparkNetwork::from_str("mainnet").unwrap();
assert_eq!(mainnet, SparkNetwork::Mainnet);

let regtest = SparkNetwork::from_str("Regtest").unwrap();
assert_eq!(regtest, SparkNetwork::Regtest);

let err = SparkNetwork::from_str("testnet");
assert!(err.is_err());

type Err = String

The associated error which can be returned from parsing.

impl Hash for SparkNetwork

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SparkNetwork

fn cmp(&self, other: &SparkNetwork) -> 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 SparkNetwork

fn eq(&self, other: &SparkNetwork) -> 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 SparkNetwork

fn partial_cmp(&self, other: &SparkNetwork) -> 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<Network> for SparkNetwork

type Error = SparkSdkError

The type returned in the event of a conversion error.

fn try_from(value: Network) -> Result<Self, SparkSdkError>

Performs the conversion.

impl TryFrom<i32> for SparkNetwork

type Error = SparkSdkError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, SparkSdkError>

Performs the conversion.

impl Copy for SparkNetwork

impl Eq for SparkNetwork

impl StructuralPartialEq for SparkNetwork