Enum EventFilter 

pub enum EventFilter {
    All,
    None,
    Only {
        types: BTreeSet<EventType>,
    },
}

Filter controlling which event types a user receives during poll.

Used alongside SubscriptionTier to give fine-grained control over the event stream. Tier controls message-level filtering (all, mentions, none); EventFilter controls which EventType values pass through for Message::Event messages specifically.

Non-Event messages are never affected by the event filter.

Variants

All

Receive all event types (the default).

None

Receive no events.

Only

Receive only the listed event types.

Fields

types: BTreeSet<EventType>

Implementations

impl EventFilter

pub fn allows(&self, event_type: &EventType) -> bool

Check whether a given event type passes this filter.

Trait Implementations

impl Clone for EventFilter

fn clone(&self) -> EventFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventFilter

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

Formats the value using the given formatter.

impl Default for EventFilter

fn default() -> EventFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EventFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EventFilter

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

Formats the value using the given formatter.

impl FromStr for EventFilter

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse an event filter from a string.

Accepted formats:

• "all" → EventFilter::All
• "none" → EventFilter::None
• "task_posted,task_finished" → EventFilter::Only with those types

type Err = String

The associated error which can be returned from parsing.

impl PartialEq for EventFilter

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for EventFilter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for EventFilter

impl StructuralPartialEq for EventFilter