Struct WordEncoder

pub struct WordEncoder { /* private fields */ }

Main encoder/decoder for three-word addresses

Implementations

impl WordEncoder

pub fn new() -> Self

Create a new word encoder with default dictionary

pub fn with_dictionary(dictionary: WordDictionary) -> Self

Create encoder with custom dictionary

pub fn encode_multiaddr( &self, multiaddr: &Multiaddr, ) -> Result<ThreeWordAddress>

Convert multiaddr to three-word address

pub fn decode_to_multiaddr(&self, words: &ThreeWordAddress) -> Result<Multiaddr>

Convert three-word address back to multiaddr Note: This requires a registry/cache since the conversion isn’t perfectly reversible

pub fn validate_words( &self, first: &str, second: &str, third: &str, ) -> Result<()>

Validate that all three words exist in the dictionary

pub fn dictionary(&self) -> &WordDictionary

Get the word dictionary

Trait Implementations

impl Clone for WordEncoder

fn clone(&self) -> WordEncoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WordEncoder

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

Formats the value using the given formatter.

impl Default for WordEncoder

fn default() -> Self

Returns the “default value” for a type.