Struct ruma_client_api::filter::RoomEventFilter
source · [−]pub struct RoomEventFilter<'a> {
pub not_types: &'a [String],
pub not_rooms: &'a [OwnedRoomId],
pub limit: Option<UInt>,
pub rooms: Option<&'a [OwnedRoomId]>,
pub not_senders: &'a [OwnedUserId],
pub senders: Option<&'a [OwnedUserId]>,
pub types: Option<&'a [String]>,
pub url_filter: Option<UrlFilter>,
pub lazy_load_options: LazyLoadOptions,
pub related_by_rel_types: &'a [RelationType],
pub related_by_senders: &'a [OwnedUserId],
}
client
or server
only.Expand description
Filters to be applied to room events.
Fields
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.
not_rooms: &'a [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<&'a [OwnedRoomId]>
A list of room IDs to include.
If this list is absent then all rooms are included.
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.
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.
url_filter: Option<UrlFilter>
Controls whether to include events with a URL key in their content.
None
: No filteringSome(EventsWithUrl)
: Only events with a URLSome(EventsWithoutUrl)
: Only events without a URL
lazy_load_options: LazyLoadOptions
Options to control lazy-loading of membership events.
Defaults to LazyLoadOptions::Disabled
.
unstable-msc3440
only.A list of relation types to include.
An event A is included in the filter only if there exists another event B which relates to
A with a rel_type
which is defined in the list.
unstable-msc3440
only.A list of senders to include.
An event A is included in the filter only if there exists another event B which relates to A, and which has a sender which is in the list.
Implementations
sourceimpl<'a> RoomEventFilter<'a>
impl<'a> RoomEventFilter<'a>
Trait Implementations
sourceimpl<'a> CanBeEmpty for RoomEventFilter<'a>
impl<'a> CanBeEmpty for RoomEventFilter<'a>
sourceimpl<'a> Clone for RoomEventFilter<'a>
impl<'a> Clone for RoomEventFilter<'a>
sourcefn clone(&self) -> RoomEventFilter<'a>
fn clone(&self) -> RoomEventFilter<'a>
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read more