Struct ruma::api::client::r0::filter::RoomEventFilter [−][src]
pub struct RoomEventFilter<'a> {
pub not_types: &'a [String],
pub not_rooms: &'a [RoomId],
pub limit: Option<UInt>,
pub rooms: Option<&'a [RoomId]>,
pub not_senders: &'a [UserId],
pub senders: Option<&'a [UserId]>,
pub types: Option<&'a [String]>,
pub url_filter: Option<UrlFilter>,
pub lazy_load_options: LazyLoadOptions,
}
api
and (crate features client-api
or client-api-c
or client-api-s
) 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 [RoomId]
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 [RoomId]>
A list of room IDs to include.
If this list is absent then all rooms are included.
not_senders: &'a [UserId]
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 [UserId]>
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
.
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.
Trait Implementations
Returns the “default value” for a type. Read more
type Incoming = IncomingRoomEventFilter
type Incoming = IncomingRoomEventFilter
The ‘Incoming’ variant of Self
.
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
Auto Trait Implementations
impl<'a> RefUnwindSafe for RoomEventFilter<'a>
impl<'a> Send for RoomEventFilter<'a>
impl<'a> Sync for RoomEventFilter<'a>
impl<'a> Unpin for RoomEventFilter<'a>
impl<'a> UnwindSafe for RoomEventFilter<'a>
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V
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