Struct u5

pub struct u5(/* private fields */);

Integer in the range 0..32

Implementations

impl u5

pub fn try_from_u8(value: u8) -> Result<u5, Error>

Convert a u8 to u5 if in range, return Error otherwise

pub fn to_u8(self) -> u8

Returns a copy of the underlying u8 value

pub fn to_char(self) -> char

Get char representing this 5 bit value as defined in BIP173

Trait Implementations

impl AsRef<u8> for u5

fn as_ref(&self) -> &u8

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for u5

fn clone(&self) -> u5

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for u5

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

Formats the value using the given formatter.

impl Default for u5

fn default() -> u5

Returns the “default value” for a type.

impl From<WitnessVersion> for u5

fn from(version: WitnessVersion) -> u5

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

impl From<WitnessVersion> for u5

fn from(version: WitnessVersion) -> u5

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

impl From<u5> for u8

fn from(v: u5) -> u8

Converts to this type from the input type.

impl Hash for u5

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

where __H: Hasher,

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 u5

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

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

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

fn try_from( value: u5, ) -> Result<WitnessVersion, <WitnessVersion as TryFrom<u5>>::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.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<u5> for WitnessVersion

fn try_from( value: u5, ) -> Result<WitnessVersion, <WitnessVersion as TryFrom<u5>>::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].

type Error = Error

The type returned in the event of a conversion error.

impl Copy for u5

impl Eq for u5

impl StructuralPartialEq for u5