Struct notcoal::Filter

pub struct Filter {
    pub desc: Option<String>,
    pub rules: Vec<BTreeMap<String, Value>>,
    pub op: Operations,
    /* private fields */
}

Fields

desc: Option<String>

Description

Not really used for anything at this point in time, but may be good for users to remember what this specific filter is doing

rules: Vec<BTreeMap<String, Value>>

List of rules

This list is an OR list, meaning the filter will match if any rule matches. However, AND combinations may happen within a rule

op: Operations

Operations that will be applied if this any rule matches

Implementations

impl Filter

pub fn new() -> Self

pub fn name(&self) -> String

Returns either the set name, or a hash of Filter::rules. Please note: hashed names are not used for serialization.

pub fn set_name(&mut self, name: &str)

pub fn compile(self) -> Result<Self>

When filters are deserialized from json or have been assembled via code, the regular expressions contained in Filter::rules need to be compiled before any matches are to be made.

pub fn apply_if_match<T>(
    &self,
    msg: &Message<'_, T>,
    db: &Database
) -> Result<(bool, bool)>where
    T: MessageOwner,

Combines Filter::is_match and Operations::apply

Returns a tuple of two bools, the first representing if the filter has been applied, the second if the operation deleted the message that was supplied

pub fn is_match<T>(&self, msg: &Message<'_, T>, db: &Database) -> Result<bool>where
    T: MessageOwner,

Checks if the supplied message matches any of the combinations described in Filter::rules

Trait Implementations

impl Debug for Filter

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

Formats the value using the given formatter.

impl Default for Filter

fn default() -> Filter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Filter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Filter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.