Struct ruma_client_api::filter::RoomEventFilter
source · #[non_exhaustive]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,
}
Expand description
Filters to be applied to room events.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.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
.
unread_thread_notifications: bool
Whether to enable per-thread notification counts.
Only applies to the sync_events
endpoint.
Implementations§
source§impl RoomEventFilter
impl RoomEventFilter
sourcepub fn empty() -> Self
pub fn empty() -> Self
Creates an empty RoomEventFilter
.
You can also use the Default
implementation.
sourcepub fn ignore_all() -> Self
pub fn ignore_all() -> Self
Creates a new RoomEventFilter
that can be used to ignore all room events.
sourcepub fn with_lazy_loading() -> Self
pub fn with_lazy_loading() -> Self
Creates a new RoomEventFilter
with room member lazy-loading enabled.
Redundant membership events are disabled.
Trait Implementations§
source§impl CanBeEmpty for RoomEventFilter
impl CanBeEmpty for RoomEventFilter
source§impl Clone for RoomEventFilter
impl Clone for RoomEventFilter
source§fn clone(&self) -> RoomEventFilter
fn clone(&self) -> RoomEventFilter
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for RoomEventFilter
impl Debug for RoomEventFilter
source§impl Default for RoomEventFilter
impl Default for RoomEventFilter
source§fn default() -> RoomEventFilter
fn default() -> RoomEventFilter
source§impl<'de> Deserialize<'de> for RoomEventFilter
impl<'de> Deserialize<'de> for RoomEventFilter
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for RoomEventFilter
impl RefUnwindSafe for RoomEventFilter
impl Send for RoomEventFilter
impl Sync for RoomEventFilter
impl Unpin for RoomEventFilter
impl UnwindSafe for RoomEventFilter
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)