Struct ruma::api::client::r0::filter::IncomingRoomFilter [−][src]
pub struct IncomingRoomFilter { pub include_leave: bool, pub account_data: IncomingRoomEventFilter, pub timeline: IncomingRoomEventFilter, pub ephemeral: IncomingRoomEventFilter, pub state: IncomingRoomEventFilter, pub not_rooms: Vec<RoomId, Global>, pub rooms: Option<Vec<RoomId, Global>>, }
api
and (crate features client-api
or client-api-c
or client-api-s
) only.Expand description
‘Incoming’ variant of RoomFilter.
Fields
include_leave: bool
Include rooms that the user has left in the sync.
Defaults to false
.
account_data: IncomingRoomEventFilter
The per user account data to include for rooms.
timeline: IncomingRoomEventFilter
The message and state update events to include for rooms.
ephemeral: IncomingRoomEventFilter
The events that aren’t recorded in the room history, e.g. typing and receipts, to include for rooms.
state: IncomingRoomEventFilter
The state events to include for rooms.
not_rooms: Vec<RoomId, 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. This filter is applied before the filters in
ephemeral
, state
, timeline
or account_data
.
rooms: Option<Vec<RoomId, Global>>
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
Trait Implementations
Returns the “default value” for a type. Read more
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<IncomingRoomFilter, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<IncomingRoomFilter, <__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 IncomingRoomFilter
impl Send for IncomingRoomFilter
impl Sync for IncomingRoomFilter
impl Unpin for IncomingRoomFilter
impl UnwindSafe for IncomingRoomFilter
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