Enum WitnessVersion 

#[repr(u8)]
pub enum WitnessVersion {
    V0 = 0,
    V1 = 1,
    V2 = 2,
    V3 = 3,
    V4 = 4,
    V5 = 5,
    V6 = 6,
    V7 = 7,
    V8 = 8,
    V9 = 9,
    V10 = 10,
    V11 = 11,
    V12 = 12,
    V13 = 13,
    V14 = 14,
    V15 = 15,
    V16 = 16,
}

Version of the witness program.

Helps limit possible versions of the witness according to the specification. If a plain u8 type was used instead it would mean that the version may be > 16, which would be incorrect.

First byte of scriptPubkey in transaction output for transactions starting with opcodes ranging from 0 to 16 (inclusive).

Variants

V0 = 0

Initial version of witness program. Used for P2WPKH and P2WPK outputs

V1 = 1

Version of witness program used for Taproot P2TR outputs.

V2 = 2

Future (unsupported) version of witness program.

V3 = 3

Future (unsupported) version of witness program.

V4 = 4

Future (unsupported) version of witness program.

V5 = 5

Future (unsupported) version of witness program.

V6 = 6

Future (unsupported) version of witness program.

V7 = 7

Future (unsupported) version of witness program.

V8 = 8

Future (unsupported) version of witness program.

V9 = 9

Future (unsupported) version of witness program.

V10 = 10

Future (unsupported) version of witness program.

V11 = 11

Future (unsupported) version of witness program.

V12 = 12

Future (unsupported) version of witness program.

V13 = 13

Future (unsupported) version of witness program.

V14 = 14

Future (unsupported) version of witness program.

V15 = 15

Future (unsupported) version of witness program.

V16 = 16

Future (unsupported) version of witness program.

Implementations

impl WitnessVersion

pub fn from_u5(value: u5) -> Result<Self, Error>

Converts 5-bit unsigned integer value matching single symbol from Bech32(m) address encoding (bech32::u5) into WitnessVersion variant.

Returns

Version of the Witness program.

Errors

If the integer does not correspond to any witness version, errors with Error::InvalidWitnessVersion.

pub fn from_num(no: u8) -> Result<Self, Error>

Converts an 8-bit unsigned integer value into WitnessVersion variant.

Returns

Version of the Witness program.

Errors

If the integer does not correspond to any witness version, errors with Error::InvalidWitnessVersion.

pub fn from_opcode(opcode: All) -> Result<Self, Error>

Converts bitcoin script opcode into WitnessVersion variant.

Returns

Version of the Witness program (for opcodes in range of OP_0..OP_16).

Errors

If the opcode does not correspond to any witness version, errors with Error::MalformedWitnessVersion.

pub fn from_instruction(instruction: Instruction<'_>) -> Result<Self, Error>

Converts bitcoin script Instruction (parsed opcode) into WitnessVersion variant.

Returns

Version of the Witness program for Instruction::Op and Instruction::PushBytes with byte value within 1..=16 range.

Errors

If the opcode does not correspond to any witness version, errors with Error::MalformedWitnessVersion for the rest of opcodes.

pub fn into_num(self) -> u8

Returns integer version number representation for a given WitnessVersion value.

NB: this is not the same as an integer representation of the opcode signifying witness version in bitcoin script. Thus, there is no function to directly convert witness version into a byte since the conversion requires context (bitcoin script or just a version number).

pub fn bech32_variant(&self) -> Variant

Determines the checksum variant. See BIP-0350 for specification.

Trait Implementations

impl Clone for WitnessVersion

fn clone(&self) -> WitnessVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WitnessVersion

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

Formats the value using the given formatter.

impl Display for WitnessVersion

Prints WitnessVersion number (from 0 to 16) as integer, without any prefix or suffix.

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

Formats the value using the given formatter.

impl From<WitnessVersion> for All

fn from(version: WitnessVersion) -> All

Converts WitnessVersion instance into corresponding Bitcoin scriptopcode (OP_0..OP_16).

impl From<WitnessVersion> for u5

fn from(version: WitnessVersion) -> Self

Converts WitnessVersion instance into corresponding Bech32(m) u5-value (bech32::u5).

impl FromStr for WitnessVersion

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for WitnessVersion

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 WitnessVersion

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

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

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

impl Eq for WitnessVersion

impl StructuralPartialEq for WitnessVersion