Struct rustrict::ContextProcessingOptions

#[non_exhaustive]
pub struct ContextProcessingOptions {
    pub block_if_muted: bool,
    pub block_if_empty: bool,
    pub block_if_severely_inappropriate: bool,
    pub safe_mode_until: Option<Instant>,
    pub character_limit: Option<NonZeroUsize>,
    pub word_break: Option<ContextWordBreakOptions>,
    pub rate_limit: Option<ContextRateLimitOptions>,
    pub repetition_limit: Option<ContextRepetitionLimitOptions>,
    pub max_safe_timeout: Duration,
    pub trim_whitespace: bool,
}

Options for customizing Context::process_with_options. Always initialize with ..Default::default(), as new fields may be added in the future.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

block_if_muted: bool

Block messages if the user has been manually muted.

block_if_empty: bool

Block messages if they are empty (after whitespace is trimmed, if applicable).

block_if_severely_inappropriate: bool

Block messages, as opposed to censoring, if severe inappropriateness is detected.

safe_mode_until: Option<Instant>

Block all messages if they are unsafe (useful for implementing moderator-activated “safe mode”). Note that unsafe messages from certain users may also be blocked automatically.

character_limit: Option<NonZeroUsize>

Character count (or, with the width feature, number of m-equivalent widths).

Messages will be trimmed to fit.

word_break: Option<ContextWordBreakOptions>

Ensure word-break will work on the message.

rate_limit: Option<ContextRateLimitOptions>

Rate-limiting options.

repetition_limit: Option<ContextRepetitionLimitOptions>

Block messages if they are very similar to this many previous message.

max_safe_timeout: Duration

Maximum automatic “safe” timeouts can last. If set too high, users have more time/incentive to try and find ways around the system. If zero, “safe” timeouts won’t be used.

trim_whitespace: bool

Trim whitespace from beginning and end before returning censored output.

Trait Implementations

impl Clone for ContextProcessingOptions

fn clone(&self) -> ContextProcessingOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContextProcessingOptions

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

Formats the value using the given formatter.

impl Default for ContextProcessingOptions

fn default() -> Self

Returns the “default value” for a type.