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 fn decode_to_bytes(&self) -> Vec<u8>

decode_to_bytes: borrowing, allocates fresh Vec<u8> from decoded bytes

pub fn variant(&self) -> EncodingVariant

Get the detected encoding variant.

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

decode_into_bytes: consuming, decodes then zeroizes the wrapper immediately

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 ExposeSecret for Bech32String

Available on crate feature encoding-bech32 only.

Implementation for Bech32String - read-only access.

Encoding wrappers only provide read-only access to prevent invalidation of validation invariants. The Inner type is str since encoded strings are always valid UTF-8.

type Inner = str

The inner secret type being exposed.

fn expose_secret(&self) -> &str

Expose the secret for read-only access.

fn len(&self) -> usize

Returns the length of the secret.

fn is_empty(&self) -> bool

Returns true if the secret is empty.

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.