Struct matrix_sdk::ruma::api::client::filter::RoomFilter
#[non_exhaustive]pub struct RoomFilter {
pub include_leave: bool,
pub account_data: RoomEventFilter,
pub timeline: RoomEventFilter,
pub ephemeral: RoomEventFilter,
pub state: RoomEventFilter,
pub not_rooms: Vec<OwnedRoomId>,
pub rooms: Option<Vec<OwnedRoomId>>,
}
api
and (crate features client
or server
) only.Expand description
Filters to be applied to room data.
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.include_leave: bool
Include rooms that the user has left in the sync.
Defaults to false
.
account_data: RoomEventFilter
The per user account data to include for rooms.
timeline: RoomEventFilter
The message and state update events to include for rooms.
ephemeral: RoomEventFilter
The events that aren’t recorded in the room history, e.g. typing and receipts, to include for rooms.
state: RoomEventFilter
The state events to include for rooms.
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. This filter is applied before the filters in
ephemeral
, state
, timeline
or account_data
.
rooms: Option<Vec<OwnedRoomId>>
A list of room IDs to include.
If this list is absent then all rooms are included. This filter is applied before the
filters in ephemeral
, state
, timeline
or account_data
.
Implementations§
§impl RoomFilter
impl RoomFilter
pub fn empty() -> RoomFilter
pub fn empty() -> RoomFilter
Creates an empty RoomFilter
.
You can also use the Default
implementation.
pub fn ignore_all() -> RoomFilter
pub fn ignore_all() -> RoomFilter
Creates a new RoomFilter
that can be used to ignore all room events (of any type).
pub fn with_lazy_loading() -> RoomFilter
pub fn with_lazy_loading() -> RoomFilter
Creates a new RoomFilter
with room member lazy-loading enabled.
Redundant membership events are disabled.
Trait Implementations§
§impl CanBeEmpty for RoomFilter
impl CanBeEmpty for RoomFilter
§impl Clone for RoomFilter
impl Clone for RoomFilter
§fn clone(&self) -> RoomFilter
fn clone(&self) -> RoomFilter
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for RoomFilter
impl Debug for RoomFilter
§impl Default for RoomFilter
impl Default for RoomFilter
§fn default() -> RoomFilter
fn default() -> RoomFilter
§impl<'de> Deserialize<'de> for RoomFilter
impl<'de> Deserialize<'de> for RoomFilter
§fn deserialize<__D>(
__deserializer: __D
) -> Result<RoomFilter, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<RoomFilter, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
§impl Serialize for RoomFilter
impl Serialize for RoomFilter
§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Auto Trait Implementations§
impl RefUnwindSafe for RoomFilter
impl Send for RoomFilter
impl Sync for RoomFilter
impl Unpin for RoomFilter
impl UnwindSafe for RoomFilter
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
§impl<T> CompatExt for T
impl<T> CompatExt for T
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
§fn new_handle(value: Arc<T>) -> Handle
fn new_handle(value: Arc<T>) -> Handle
§fn clone_handle(handle: Handle) -> Handle
fn clone_handle(handle: Handle) -> Handle
§fn consume_handle(handle: Handle) -> Arc<T>
fn consume_handle(handle: Handle) -> Arc<T>
Arc<>
§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian()
.