Struct ruma_client_api::r0::filter::FilterDefinition

pub struct FilterDefinition {
    pub event_fields: Option<Vec<String>>,
    pub event_format: Option<EventFormat>,
    pub account_data: Option<Filter>,
    pub room: Option<RoomFilter>,
    pub presence: Option<Filter>,
}

A filter definition

Fields

event_fields: Option<Vec<String>>

List of event fields to include.

If this list is absent then all fields are included. The entries may include '.' charaters to indicate sub-fields. So ['content.body'] will include the 'body' field of the 'content' object. A literal '.' character in a field name may be escaped using a ''. A server may include more fields than were requested.

event_format: Option<EventFormat>

The format to use for events.

'client' will return the events in a format suitable for clients. 'federation' will return the raw event as received over federation. The default is 'client'.

account_data: Option<Filter>

The user account data that isn't associated with rooms to include.

room: Option<RoomFilter>

Filters to be applied to room data.

presence: Option<Filter>

The presence updates to include.

Methods

impl FilterDefinition

pub fn ignore_all() -> Self

A filter that can be used to ignore all events

Trait Implementations

impl Clone for FilterDefinition

fn clone(&self) -> FilterDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilterDefinition

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for FilterDefinition

fn default() -> FilterDefinition

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for FilterDefinition

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

Deserialize this value from the given Serde deserializer.

impl Serialize for FilterDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.