Struct Options

pub struct Options(/* private fields */);

A configuration struct where you can customize decancer’s behavior.

By default, decancer cures as much characters as possible and turns all the output characters to lowercase.

If you don’t plan on using this struct and only using decancer’s defaults, it’s recommended to disable the default options feature flag to optimize away unnecessary option checks.

use decancer::Options;

// by default, all options are disabled
let _options = Options::default();

Implementations

impl Options

pub const fn all() -> Self

Creates a new configuration where every option is enabled.

pub const fn pure_homoglyph() -> Self

Creates a new configuration that prevents decancer from curing characters from major foreign writing systems, including diacritics.

pub const fn retain_capitalization(self) -> Self

Prevents decancer from changing all characters to lowercase. Therefore, if the input character is in uppercase, the output character will be in uppercase as well.

NOTE: Many confusables are neither an uppercase or a lowercase character. Therefore, the decancer defaults to displaying the translation in lowercase:

use decancer::{Translation, Options};
use std::borrow::Cow;

let options = Options::default()
  .retain_capitalization();

assert_eq!('🆐'.to_lowercase().collect::<String>(), '🆐'.to_uppercase().collect::<String>());
assert_eq!(decancer::cure_char('🆐', options), Translation::String(Cow::Borrowed("dj")));

pub const fn disable_bidi(self) -> Self

Prevents decancer from applying the Unicode Bidirectional Algorithm. Use this only when you don’t expect any right-to-left characters. Enabling this option has no effect if it’s called on cure_char.

NOTE: This speeds up the function call, but can break right-to-left characters. It’s highly recommended to also use retain_arabic and retain_hebrew.

pub const fn retain_diacritics(self) -> Self

Prevents decancer from curing characters with diacritics or accents.

NOTE: Decancer can still cure standalone diacritic characters, which is used in Zalgo texts.

pub const fn retain_japanese(self) -> Self

Prevents decancer from curing all katakana and hiragana characters.

NOTE: To also provent decancer from curing kanji characters, use retain_chinese.

pub const fn retain_emojis(self) -> Self

Prevents decancer from curing all emojis.

pub const fn retain_turkish(self) -> Self

Prevents decancer from curing all turkish characters.

NOTE: To also prevent decancer from curing the uppercase dotted i character (İ), use retain_capitalization.

pub const fn ascii_only(self) -> Self

Removes all non-ASCII characters from the result.

pub const fn alphanumeric_only(self) -> Self

Removes all non-alphanumeric characters from the result.

pub const fn retain_greek(self) -> Self

Prevents decancer from curing all greek characters.

pub const fn retain_cyrillic(self) -> Self

Prevents decancer from curing all cyrillic characters.

pub const fn retain_hebrew(self) -> Self

Prevents decancer from curing all hebrew characters.

pub const fn retain_arabic(self) -> Self

Prevents decancer from curing all arabic characters.

pub const fn retain_devanagari(self) -> Self

Prevents decancer from curing all devanagari characters.

pub const fn retain_bengali(self) -> Self

Prevents decancer from curing all bengali characters.

pub const fn retain_armenian(self) -> Self

Prevents decancer from curing all armenian characters.

pub const fn retain_gujarati(self) -> Self

Prevents decancer from curing all gujarati characters.

pub const fn retain_tamil(self) -> Self

Prevents decancer from curing all tamil characters.

pub const fn retain_thai(self) -> Self

Prevents decancer from curing all thai characters.

pub const fn retain_lao(self) -> Self

Prevents decancer from curing all lao characters.

pub const fn retain_burmese(self) -> Self

Prevents decancer from curing all burmese characters.

pub const fn retain_khmer(self) -> Self

Prevents decancer from curing all khmer characters.

pub const fn retain_mongolian(self) -> Self

Prevents decancer from curing all mongolian characters.

pub const fn retain_chinese(self) -> Self

Prevents decancer from curing all chinese characters.

pub const fn retain_korean(self) -> Self

Prevents decancer from curing all korean characters.

pub const fn retain_braille(self) -> Self

Prevents decancer from curing all braille characters.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl Hash for Options

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 Options

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

impl Eq for Options

impl StructuralPartialEq for Options