Struct Bech32String 

pub struct Bech32String { /* private fields */ }

Validated Bech32/Bech32m string wrapper for secret data.

Implementations

impl Bech32String

pub fn new(s: String) -> Result<Self, &'static str>

Create a new Bech32String from a String, validating and normalizing it.

Accepts mixed-case input (normalized to lowercase for storage).

Security Note

Invalid inputs are only securely zeroized if the zeroize feature is enabled. Without zeroize, rejected bytes may remain in memory until the String is dropped normally. Enable the zeroize feature for secure wiping of invalid inputs.

pub fn is_bech32(&self) -> bool

Check if this is a Bech32 encoding.

pub fn is_bech32m(&self) -> bool

Check if this is a Bech32m encoding.

pub fn hrp(&self) -> Hrp

Get the Human-Readable Part (HRP) of the string.

pub fn byte_len(&self) -> usize

Exact number of bytes the decoded payload represents (allocation-free).

pub const fn len(&self) -> usize

Length of the encoded string (in characters).

pub const fn is_empty(&self) -> bool

Whether the encoded string is empty.

pub fn variant(&self) -> EncodingVariant

Get the detected encoding variant.

pub fn into_bytes(self) -> Vec<u8>

Decode the validated Bech32/Bech32m string into raw bytes, consuming the wrapper.

impl Bech32String

pub fn expose_secret(&self) -> Bech32StringView<'_>

Trait Implementations

impl Debug for Bech32String

Debug implementation (always redacted).

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

Formats the value using the given formatter.

impl PartialEq for Bech32String

Available on crate feature ct-eq only.

Constant-time equality (prevents timing attacks when comparing encoded secrets).

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

Equality implementation.