Enum Dialect 

pub enum Dialect {
    American = 1,
    Canadian = 2,
    Australian = 4,
    British = 8,
}

A regional dialect.

Note: these have bit-shifted values so that they can ergonomically integrate with DialectFlags. Each value here must have a unique bit index inside DialectsUnderlyingType.

Variants

American = 1

Canadian = 2

Australian = 4

British = 8

Implementations

impl Dialect

pub fn try_guess_from_document(document: &Document) -> Option<Self>

Tries to guess the dialect used in the document by finding which dialect is used the most. Returns None if it fails to find a single dialect that is used the most.

pub fn try_from_abbr(abbr: &str) -> Option<Self>

Tries to get a dialect from its abbreviation. Returns None if the abbreviation is not recognized.

Examples

use harper_core::Dialect;

let abbrs = ["US", "CA", "AU", "GB"];
let mut dialects = abbrs.iter().map(|abbr| Dialect::try_from_abbr(abbr));

assert_eq!(Some(Dialect::American), dialects.next().unwrap()); // US
assert_eq!(Some(Dialect::Canadian), dialects.next().unwrap()); // CA
assert_eq!(Some(Dialect::Australian), dialects.next().unwrap()); // AU
assert_eq!(Some(Dialect::British), dialects.next().unwrap()); // GB

Trait Implementations

impl Clone for Dialect

fn clone(&self) -> Dialect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dialect

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Dialect

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Dialect

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

Formats the value using the given formatter.

impl EnumCount for Dialect

const COUNT: usize = 4usize

impl FromStr for Dialect

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Dialect, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Dialect

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 IntoEnumIterator for Dialect

type Iterator = DialectIter

fn iter() -> DialectIter

impl PartialEq for Dialect

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

fn partial_cmp(&self, other: &Dialect) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Dialect

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Dialect

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Dialect, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<DialectFlags> for Dialect

fn try_from(dialect_flags: DialectFlags) -> Result<Self, Self::Error>

Attempts to convert DialectFlags to a single Dialect.

Errors

Will return Err if more than one dialect is enabled or if an undefined dialect is enabled.

type Error = ()

The type returned in the event of a conversion error.

impl VariantArray for Dialect

const VARIANTS: &'static [Self]

impl Copy for Dialect

impl Eq for Dialect

impl StructuralPartialEq for Dialect