Struct ruma_client_api::filter::FilterDefinition

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

A filter definition

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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 ‘.’ characters to indicate sub-fields. So [‘content.body’] will include the ‘body’ field of the ‘content’ object. A literal ‘.’ or ’' character in a field name may be escaped using a ’'. A server may include more fields than were requested.

event_format: 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’.

presence: Filter

The presence updates to include.

account_data: Filter

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

room: RoomFilter

Filters to be applied to room data.

Implementations

impl FilterDefinition

pub fn empty() -> Self

Creates an empty FilterDefinition.

You can also use the Default implementation.

pub fn ignore_all() -> Self

Creates a new FilterDefinition that can be used to ignore all events.

pub fn with_lazy_loading() -> Self

Creates a new FilterDefinition with room member lazy-loading enabled.

Redundant membership events are disabled.

pub fn is_empty(&self) -> bool

Returns true if all fields are empty.

Trait Implementations

impl CanBeEmpty for FilterDefinition

fn is_empty(&self) -> bool

Check whether self is empty.

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 From<FilterDefinition> for Filter

fn from(def: FilterDefinition) -> Self

Converts to this type from the input type.

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.