Struct Settings 

pub struct Settings {
    pub word_len: Option<u8>,
    pub checksum: Checksum,
    pub decorate: bool,
}

Settings used when encoding.

Fields

word_len: Option<u8>

Maximum number of syllables allowed in a word. Note that the actual number of syllables in a word may be smaller. Default: 3.

checksum: Checksum

The checksum settings used. Default: Checksum::Length1.

decorate: bool

If enabled, encoded strings are decorated with commas, periods, and sentence casing. This can make the encoded string more readable, but also longer. All decorations are ignored when decoding. Default: false.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Settings

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 Settings

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

impl Eq for Settings

impl StructuralPartialEq for Settings