pub struct RoomEventFilter {
    pub not_types: Vec<String>,
    pub not_rooms: Vec<OwnedRoomId>,
    pub limit: Option<UInt>,
    pub rooms: Option<Vec<OwnedRoomId>>,
    pub not_senders: Vec<OwnedUserId>,
    pub senders: Option<Vec<OwnedUserId>>,
    pub types: Option<Vec<String>>,
    pub url_filter: Option<UrlFilter>,
    pub lazy_load_options: LazyLoadOptions,
    pub unread_thread_notifications: bool,
}
Available on crate features client or server only.
Expand description

Filters to be applied to room events.

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.

§not_rooms: Vec<OwnedRoomId>

A list of room IDs to exclude.

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

§limit: Option<UInt>

The maximum number of events to return.

§rooms: Option<Vec<OwnedRoomId>>

A list of room IDs to include.

If this list is absent then all rooms are included.

§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.

§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.

§url_filter: Option<UrlFilter>

Controls whether to include events with a URL key in their content.

  • None: No filtering
  • Some(EventsWithUrl): Only events with a URL
  • Some(EventsWithoutUrl): Only events without a URL
§lazy_load_options: LazyLoadOptions

Options to control lazy-loading of membership events.

Defaults to LazyLoadOptions::Disabled.

§unread_thread_notifications: bool

Whether to enable per-thread notification counts.

Only applies to the sync_events endpoint.

Implementations§

Creates an empty RoomEventFilter.

You can also use the Default implementation.

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

Returns true if all fields are empty.

Trait Implementations§

Check whether self is empty.
Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Deserialize this value from the given Serde deserializer. Read more
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more