Struct Hrp 

pub struct Hrp(pub String);

Human-readable part (HRP) of Bech32 structure.

A valid HRP string must meet all following conditions:

• String length must be in the range 1..84.
• Must only contain ASCII characters in the range 33..127.
• Must not contain a mixture of uppercase and lowercase alphabetic characters.

Note: Stored as lowercase.

Examples

Parse string as Hrp:

use pbech32::Hrp;

let s = "testhrp"; // hrp string
let hrp: Hrp = s.parse()?; // parse string

Convert Hrp to a string:

use pbech32::Hrp;

let s = "foobar"; // hrp string
let hrp: Hrp = s.parse()?; // parse string
assert_eq!(hrp.to_string(), "foobar"); // check result

Convert Hrp to a &str with Hrp::as_ref():

use pbech32::Hrp;

let s = "foobar"; // hrp string
let hrp: Hrp = s.parse()?; // parse string
assert_eq!(hrp.as_ref(), "foobar"); // check result

Strings which contain all uppercase characters are converted to lowercase when parsed as an Hrp:

use pbech32::Hrp;

let hrp: Hrp = "TESTHRP".parse()?; // parse hrp string
assert_eq!(hrp.to_string(), "testhrp"); // check result

Parsing will fail if the given string is not a valid human-readable part. For example, here is a mixed-case string:

use pbech32::{Err, Hrp};

let s = "FOObar"; // mixed-case string
let got = s.parse::<Hrp>(); // parse string
assert_eq!(got, Err(Err::MixedCase(3, 0))); // check result

Tuple Fields

0: String

Trait Implementations

impl AsRef<str> for Hrp

fn as_ref(&self) -> &str

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

impl Clone for Hrp

fn clone(&self) -> Hrp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hrp

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

Formats the value using the given formatter.

impl Display for Hrp

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

Formats the value using the given formatter.

impl FromStr for Hrp

type Err = Err

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 PartialEq for Hrp

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

impl StructuralPartialEq for Hrp