Enum censor::Censor

pub enum Censor {
    Standard,
    Sex,
    Zealous,
    Custom(HashSet<String>),
}

A collection of words to censor

Variants

Standard

Standard swear words

For more information, see STANDARD_WORDS

Sex

Words related to sex

Not usually used by itself

For more information, see SEX_WORDS

Zealous

Words that are profanities only to the zealous

Not usually used by itself

For more information, see ZEALOUS_WORDS

Custom(HashSet<String>)

A custom set of words

Implementations

impl Censor

pub fn empty() -> Self

Create an empty Censor

pub fn custom<I, W>(words: I) -> Selfwhere
    I: IntoIterator<Item = W>,
    W: Into<String>,

Create a Censor::Custom

pub fn check(&self, text: &str) -> bool

Check if a string contains censored words

pub fn count(&self, text: &str) -> usize

Count the number of censored words in a string

Example

use censor::*;

let censor = Censor::Standard;

assert_eq!(0, censor.count("dog"));
assert_eq!(1, censor.count("motherfucker"));
assert_eq!(2, censor.count("bitch ass guy"));

pub fn censor(&self, text: &str) -> String

Replace censored words in the string with asterisks (*s)

pub fn replace(&self, text: &str, grawlix: &str) -> String

Replace censored words in the string with characters from a ‘grawlix’ string (#?!@$)

Panics

Panics if the grawlix string is empty

pub fn replace_with_offsets(
    &self,
    text: &str,
    grawlix: &str,
    start_offset: usize,
    end_offset: usize
) -> String

Replace censored words in the string with characters from a ‘grawlix’ string (#?!@$)

Characters at indices within the given offsets from the start and end of words will not be censored

Panics

Panics if the grawlix string is empty

pub fn bad_chars(
    &self,
    text: &str,
    start_offset: usize,
    end_offset: usize
) -> HashSet<usize>

Get a set of the indices of characters in the given string that are part of censored words

pub fn set(&self) -> &HashSet<String>

Get a reference to the set used by the Censor

pub fn list(&self) -> Iter<'_, String>

Get an iterator over all censored words

pub fn find(&self, word: &str) -> Option<&str>

Find a censored word in the Censor. Applies character aliases

pub fn contains(&self, word: &str) -> bool

Check if the Censor contains a word. Applies character aliases

Trait Implementations

impl Add<Censor> for Censor

type Output = Censor

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<S> Add<S> for Censorwhere
    S: Into<String>,

type Output = Censor

The resulting type after applying the + operator.

fn add(self, other: S) -> Self::Output

Performs the + operation.

impl AddAssign<Censor> for Censor

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<S> AddAssign<S> for Censorwhere
    S: Into<String>,

fn add_assign(&mut self, other: S)

Performs the += operation.

impl Clone for Censor

fn clone(&self) -> Censor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Censor

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

Formats the value using the given formatter.

impl Default for Censor

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Censor> for Censor

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<Censor> for Censor

type Output = Censor

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl<S> Sub<S> for Censorwhere
    S: Into<String>,

type Output = Censor

The resulting type after applying the - operator.

fn sub(self, other: S) -> Self::Output

Performs the - operation.

impl SubAssign<Censor> for Censor

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<S> SubAssign<S> for Censorwhere
    S: Into<String>,

fn sub_assign(&mut self, other: S)

Performs the -= operation.

impl Eq for Censor

impl StructuralEq for Censor