Struct bitcoin_bech32::WitnessProgram

pub struct WitnessProgram { /* fields omitted */ }

Witness version and program data

Methods

impl WitnessProgram

pub fn new(
    version: u5,
    program: Vec<u8>,
    network: Network
) -> Result<WitnessProgram, Error>

Construct a new WitnessProgram given the constituent version, witness program and network version

pub fn to_address(&self) -> String

Converts a Witness Program to a SegWit Address

pub fn from_address(address: &str) -> Result<WitnessProgram, Error>

Decodes a segwit address into a Witness Program

Verifies that the address contains a known human-readable part hrp and decodes as proper Bech32-encoded string. Allowed values of the human-readable part correspond to the defined types in constants

pub fn to_scriptpubkey(&self) -> Vec<u8>

Converts a WitnessProgram to a script public key

The format for the output is [version, program length, <program>]

pub fn from_scriptpubkey(
    pubkey: &[u8],
    network: Network
) -> Result<WitnessProgram, Error>

Extracts a WitnessProgram out of a provided script public key

pub fn validate(&self) -> Result<(), Error>

Validates the WitnessProgram against version and length constraints

pub fn version(&self) -> u5

Witness program version

pub fn program(&self) -> &[u8]

Witness program serialized as 8-bit bytes

pub fn network(&self) -> Network

Which network this witness program is intended to be run on

Trait Implementations

impl PartialEq<WitnessProgram> for WitnessProgram

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

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

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

This method tests for !=.

impl ToString for WitnessProgram

fn to_string(&self) -> String

Converts the given value to a String.

impl Ord for WitnessProgram

fn cmp(&self, other: &WitnessProgram) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Clone for WitnessProgram

fn clone(&self) -> WitnessProgram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for WitnessProgram

impl PartialOrd<WitnessProgram> for WitnessProgram

fn partial_cmp(&self, other: &WitnessProgram) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &WitnessProgram) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &WitnessProgram) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &WitnessProgram) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &WitnessProgram) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for WitnessProgram

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

Formats the value using the given formatter.

impl Hash for WitnessProgram

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, 

Feeds a slice of this type into the given [Hasher].

impl FromStr for WitnessProgram

type Err = Error

The associated error which can be returned from parsing.

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

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