Struct ruma_client_api::filter::Filter

pub struct Filter {
    pub not_types: Vec<String>,
    pub limit: Option<UInt>,
    pub senders: Option<Vec<OwnedUserId>>,
    pub types: Option<Vec<String>>,
    pub not_senders: Vec<OwnedUserId>,
}

Available on crate features client or server only.

Filter for non-room data.

Fields

not_types: Vec<String>

A list of event types to exclude.

If this list is absent then no event types are excluded. A matching type will be excluded even if it is listed in the ‘types’ filter. A ‘*’ can be used as a wildcard to match any sequence of characters.

limit: Option<UInt>

The maximum number of events to return.

senders: Option<Vec<OwnedUserId>>

A list of senders IDs to include.

If this list is absent then all senders are included.

types: Option<Vec<String>>

A list of event types to include.

If this list is absent then all event types are included. A ‘*’ can be used as a wildcard to match any sequence of characters.

not_senders: Vec<OwnedUserId>

A list of sender IDs to exclude.

If this list is absent then no senders are excluded. A matching sender will be excluded even if it is listed in the ‘senders’ filter.

Implementations

impl Filter

pub fn empty() -> Self

Creates an empty Filter.

You can also use the Default implementation.

pub fn ignore_all() -> Self

Creates a new Filter that can be used to ignore all events.

pub fn is_empty(&self) -> bool

Returns true if all fields are empty.

Trait Implementations

impl CanBeEmpty for Filter

fn is_empty(&self) -> bool

Check whether self is empty.

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

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.