Struct HumanReadableName 

pub struct HumanReadableName { /* private fields */ }

A struct containing the two parts of a BIP 353 Human Readable Name - the user and domain parts.

The user and domain parts, together, cannot exceed 231 bytes in length, and both must be non-empty.

If you intend to handle non-ASCII user or domain parts, you must handle Homograph Attacks and do punycode en-/de-coding yourself. This struct will always handle only plain ASCII user and domain parts.

This struct can also be used for LN-Address recipients.

Implementations

impl HumanReadableName

pub fn new(user: &str, domain: &str) -> Result<HumanReadableName, ()>

Constructs a new HumanReadableName from the user and domain parts. See the struct-level documentation for more on the requirements on each.

pub fn from_encoded(encoded: &str) -> Result<HumanReadableName, ()>

Constructs a new HumanReadableName from the standard encoding - user@domain.

If user includes the standard BIP 353 ₿ prefix it is automatically removed as required by BIP 353.

pub fn user(&self) -> &str

Gets the user part of this Human Readable Name

pub fn domain(&self) -> &str

Gets the domain part of this Human Readable Name

Trait Implementations

impl Clone for HumanReadableName

fn clone(&self) -> HumanReadableName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HumanReadableName

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

Formats the value using the given formatter.

impl Display for HumanReadableName

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

Formats the value using the given formatter.

impl Hash for HumanReadableName

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

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

fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl Writeable for HumanReadableName

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Copy for HumanReadableName

impl Eq for HumanReadableName

impl StructuralPartialEq for HumanReadableName