Struct ruma_client_api::filter::IncomingRoomEventFilter
source · [−]pub struct IncomingRoomEventFilter {
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 related_by_rel_types: Vec<RelationType>,
pub related_by_senders: Vec<OwnedUserId>,
}
client
or server
only.Expand description
‘Incoming’ variant of RoomEventFilter.
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 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
Trait Implementations
sourceimpl CanBeEmpty for IncomingRoomEventFilter
impl CanBeEmpty for IncomingRoomEventFilter
sourceimpl Clone for IncomingRoomEventFilter
impl Clone for IncomingRoomEventFilter
sourcefn clone(&self) -> IncomingRoomEventFilter
fn clone(&self) -> IncomingRoomEventFilter
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read more