Struct ruma_client_api::filter::IncomingRoomFilter
source · [−]pub struct IncomingRoomFilter {
pub include_leave: bool,
pub account_data: IncomingRoomEventFilter,
pub timeline: IncomingRoomEventFilter,
pub ephemeral: IncomingRoomEventFilter,
pub state: IncomingRoomEventFilter,
pub not_rooms: Vec<OwnedRoomId>,
pub rooms: Option<Vec<OwnedRoomId>>,
}
client
or server
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<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
Trait Implementations
sourceimpl CanBeEmpty for IncomingRoomFilter
impl CanBeEmpty for IncomingRoomFilter
sourceimpl Clone for IncomingRoomFilter
impl Clone for IncomingRoomFilter
sourcefn clone(&self) -> IncomingRoomFilter
fn clone(&self) -> IncomingRoomFilter
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read more