Struct rustrict::Trie

pub struct Trie { /* private fields */ }

Efficiently stores profanity, false positives, and safe words.

Implementations

impl Trie

pub fn new() -> Self

Empty.

pub unsafe fn customize_default() -> &'static mut Self

Available on crate feature customize only.

Allows direct mutable access to the global default trie of words.

Prefer the safe API Censor::with_trie.

Safety

You must manually avoid concurrent access/censoring.

pub fn set(&mut self, word: &str, typ: Type)

Adds a word, with the given type. The type can be Type::SAFE, or a combination of Type::PROFANE, Type::Sexual, Type::Offensive, Type::Mean, Type::Mild, Type::Moderate, and Type::Severe, but NOT both (can’t be safe and unsafe).

It is recommended to use all lower-case, which will match both cases. Upper-case characters will only match upper-case.

Warning

Any profanity words added this way will not support false positives. For example, if you add the word “field,” you can expect “cornfield” to be detected as well, unless you call add_word("cornfield", Type::None).

Trait Implementations

impl Clone for Trie

fn clone(&self) -> Trie

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Trie

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

Formats the value using the given formatter.

impl Default for Trie

fn default() -> Self

Returns the “default value” for a type.

impl FromIterator<(&'static str, Type)> for Trie

fn from_iter<T: IntoIterator<Item = (&'static str, Type)>>(iter: T) -> Self

Creates a value from an iterator.