Struct WordListMetadata 

pub struct WordListMetadata {
    pub name: Cow<'static, str>,
    pub script: Option<Cow<'static, str>>,
    pub language: Option<Cow<'static, str>>,
}

Metadata about a WordList.

If you don’t want to mess around with the 🐄s, convenience methods are provided for reading fields:

• WordListMetadata::name
• WordListMetadata::script
• WordListMetadata::language

Fields

name: Cow<'static, str>

The cosmetic name for the word list

script: Option<Cow<'static, str>>

The script of the word list, if known.

The script is expected to be an ISO 15924 four-letter capitalised code.

language: Option<Cow<'static, str>>

The language of the word list, if known.

The language is expected to be an ISO 639-1 two-letter code.

Implementations

impl WordListMetadata

pub fn load(metadata_path: impl AsRef<Path>) -> Result<Self, WordListError>

Load metadata from an on-disk TOML file

pub fn name(&self) -> &str

Get the name of the word list.

pub fn script(&self) -> Option<&str>

Get the script of the word list, if known.

The script is expected to be an ISO 15924 four-letter capitalised code, but this is only guaranteed for built-in word lists.

pub fn language(&self) -> Option<&str>

Get the language of the word list, if known.

The language is expected to be an ISO 639-1 two-letter code, but this is only guaranteed for built-in word lists.

Trait Implementations

impl Clone for WordListMetadata

fn clone(&self) -> WordListMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WordListMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WordListMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> From<S> for WordListMetadata

where S: Into<Cow<'static, str>>,

fn from(word_list_name: S) -> Self

Converts to this type from the input type.

impl Hash for WordListMetadata

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 WordListMetadata

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

impl StructuralPartialEq for WordListMetadata