Struct ruma::api::client::filter::IncomingRoomEventFilter

pub struct IncomingRoomEventFilter {
    pub not_types: Vec<String, Global>,
    pub not_rooms: Vec<OwnedRoomId, Global>,
    pub limit: Option<UInt>,
    pub rooms: Option<Vec<OwnedRoomId, Global>>,
    pub not_senders: Vec<OwnedUserId, Global>,
    pub senders: Option<Vec<OwnedUserId, Global>>,
    pub types: Option<Vec<String, Global>>,
    pub url_filter: Option<UrlFilter>,
    pub lazy_load_options: LazyLoadOptions,
    pub related_by_rel_types: Vec<RelationType, Global>,
    pub related_by_senders: Vec<OwnedUserId, Global>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

‘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<OwnedRoomId, 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<OwnedRoomId, Global>>

A list of room IDs to include.

If this list is absent then all rooms are included.

not_senders: Vec<OwnedUserId, 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<OwnedUserId, 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 filtering
• Some(EventsWithUrl): Only events with a URL
• Some(EventsWithoutUrl): Only events without a URL

lazy_load_options: LazyLoadOptions

Options to control lazy-loading of membership events.

Defaults to LazyLoadOptions::Disabled.

related_by_rel_types: Vec<RelationType, Global>

Available on crate feature unstable-msc3440 only.

A list of relation types to include.

An event A is included in the filter only if there exists another event B which relates to A with a rel_type which is defined in the list.

related_by_senders: Vec<OwnedUserId, Global>

Available on crate feature unstable-msc3440 only.

A list of senders to include.

An event A is included in the filter only if there exists another event B which relates to A, and which has a sender which is in the list.

Implementations

impl IncomingRoomEventFilter

pub fn is_empty(&self) -> bool

Returns true if all fields are empty.

Trait Implementations

impl CanBeEmpty for IncomingRoomEventFilter

fn is_empty(&self) -> bool

Check whether self is empty.

impl Clone for IncomingRoomEventFilter

fn clone(&self) -> IncomingRoomEventFilter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IncomingRoomEventFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for IncomingRoomEventFilter

fn default() -> IncomingRoomEventFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IncomingRoomEventFilter

fn deserialize<__D>(
    __deserializer: __D
) -> Result<IncomingRoomEventFilter, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IncomingRoomEventFilter

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.