Struct rustrict::Context

pub struct Context { /* private fields */ }

Context is useful for taking moderation actions on a per-user basis i.e. each user would get their own Context.

Implementations

impl Context

pub fn new() -> Self

pub fn process(&mut self, message: String) -> Result<String, BlockReason>

Takes user message, returns censored message trimmed of whitespace (if it should be sent) or BlockReason (explaining why it should be blocked entirely).

pub fn process_with_options(
    &mut self,
    message: String,
    options: &ContextProcessingOptions
) -> Result<String, BlockReason>

Takes user message, returns censored message trimmed of whitespace (if it should be sent) or BlockReason (explaining why it should be blocked entirely).

Takes a set of options for fine-tuning the processing.

pub fn muted_for(&self) -> Option<Duration>

Returns how long the user is muted for, if at all.

pub fn restricted_for(&self) -> Option<Duration>

Returns how long the user is restricted to Type::SAFE for, if at all.

pub fn mute_for(&mut self, duration: Duration)

Manually mute this user’s messages for a duration. Overwrites any previous manual mute. Passing Duration::ZERO will therefore un-mute.

pub fn restrict_for(&mut self, duration: Duration)

Manually restrict this user’s messages to known safe phrases for a duration. Overwrites any previous manual restriction. Passing Duration::ZERO will therefore un-restrict.

pub fn report(&mut self)

Call if another user “reports” this user’s message(s). The function of reports is for suspicion of bad behavior to be confirmed faster.

pub fn reports(&self) -> usize

Returns number of reports received via Self::report(). It is not guaranteed that the full range of usize of reports will be counted (currently only u8::MAX are counted).

pub fn exonerate(&mut self)

Clear suspicion and reports, and automatic mutes (not manual mute or rate limit).

pub fn total(&self) -> usize

Returns total number of messages processed. It is not guaranteed that the full range of usize of messages will be counted (currently only u16::MAX are counted).

pub fn total_inappropriate(&self) -> usize

Returns total number of messages processed that were Type::INAPPROPRIATE. It is not guaranteed that the full range of usize of messages will be counted (currently only u16::MAX are counted).

Trait Implementations

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.