Struct ruma_client_api::filter::Filter

#[non_exhaustive]
pub struct Filter<'a> {
    pub not_types: &'a [String],
    pub limit: Option<UInt>,
    pub senders: Option<&'a [OwnedUserId]>,
    pub types: Option<&'a [String]>,
    pub not_senders: &'a [OwnedUserId],
}

Filter for non-room data.

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.

not_types: &'a [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<&'a [OwnedUserId]>

A list of senders IDs to include.

If this list is absent then all senders are included.

types: Option<&'a [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: &'a [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<'a> Filter<'a>

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<'a> CanBeEmpty for Filter<'a>

fn is_empty(&self) -> bool

Check whether self is empty.

impl<'a> Clone for Filter<'a>

fn clone(&self) -> Filter<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Filter<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Filter<'a>

fn default() -> Filter<'a>

Returns the “default value” for a type.

impl<'a> Serialize for Filter<'a>

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

Serialize this value into the given Serde serializer.