Struct ruma::api::client::r0::filter::IncomingRoomEventFilter [−][src]
pub struct IncomingRoomEventFilter { pub not_types: Vec<String, Global>, pub not_rooms: Vec<String, Global>, pub limit: Option<UInt>, pub rooms: Option<Vec<RoomId, Global>>, pub not_senders: Vec<UserId, Global>, pub senders: Option<Vec<UserId, Global>>, pub types: Option<Vec<String, Global>>, 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
‘Incoming’ variant of RoomEventFilter.
Fields
not_types: Vec<String, Global>
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<String, Global>
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<RoomId, Global>>
A list of room IDs to include.
If this list is absent then all rooms are included.
not_senders: Vec<UserId, Global>
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<UserId, Global>>
A list of senders IDs to include.
If this list is absent then all senders are included.
types: Option<Vec<String, Global>>
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
Trait Implementations
Returns the “default value” for a type. Read more
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<IncomingRoomEventFilter, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<IncomingRoomEventFilter, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
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 RefUnwindSafe for IncomingRoomEventFilter
impl Send for IncomingRoomEventFilter
impl Sync for IncomingRoomEventFilter
impl Unpin for IncomingRoomEventFilter
impl UnwindSafe for IncomingRoomEventFilter
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