Struct ruma::api::client::filter::IncomingFilterDefinition

pub struct IncomingFilterDefinition {
    pub event_fields: Option<Vec<String, Global>>,
    pub event_format: EventFormat,
    pub presence: IncomingFilter,
    pub account_data: IncomingFilter,
    pub room: IncomingRoomFilter,
}

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 FilterDefinition.

Fields

event_fields: Option<Vec<String, Global>>

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 ‘.’ 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: IncomingFilter

The presence updates to include.

account_data: IncomingFilter

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

room: IncomingRoomFilter

Filters to be applied to room data.

Implementations

impl IncomingFilterDefinition

pub fn is_empty(&self) -> bool

Returns true if all fields are empty.

Trait Implementations

impl CanBeEmpty for IncomingFilterDefinition

fn is_empty(&self) -> bool

Check whether self is empty.

impl Clone for IncomingFilterDefinition

fn clone(&self) -> IncomingFilterDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IncomingFilterDefinition

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

Formats the value using the given formatter.

impl Default for IncomingFilterDefinition

fn default() -> IncomingFilterDefinition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IncomingFilterDefinition

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

Deserialize this value from the given Serde deserializer.

impl Serialize for IncomingFilterDefinition

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.