Struct ruma_client_api::filter::IncomingFilterDefinition
source · [−]pub struct IncomingFilterDefinition {
pub event_fields: Option<Vec<String>>,
pub event_format: EventFormat,
pub presence: IncomingFilter,
pub account_data: IncomingFilter,
pub room: IncomingRoomFilter,
}
Available on crate features
client
or server
only.Expand description
‘Incoming’ variant of FilterDefinition.
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 ‘.’ 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
Trait Implementations
sourceimpl CanBeEmpty for IncomingFilterDefinition
impl CanBeEmpty for IncomingFilterDefinition
sourceimpl Clone for IncomingFilterDefinition
impl Clone for IncomingFilterDefinition
sourcefn clone(&self) -> IncomingFilterDefinition
fn clone(&self) -> IncomingFilterDefinition
Returns a copy of the value. Read more
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresourceimpl Debug for IncomingFilterDefinition
impl Debug for IncomingFilterDefinition
sourceimpl Default for IncomingFilterDefinition
impl Default for IncomingFilterDefinition
sourcefn default() -> IncomingFilterDefinition
fn default() -> IncomingFilterDefinition
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for IncomingFilterDefinition
impl<'de> Deserialize<'de> for IncomingFilterDefinition
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Serialize for IncomingFilterDefinition
impl Serialize for IncomingFilterDefinition
Auto Trait Implementations
impl RefUnwindSafe for IncomingFilterDefinition
impl Send for IncomingFilterDefinition
impl Sync for IncomingFilterDefinition
impl Unpin for IncomingFilterDefinition
impl UnwindSafe for IncomingFilterDefinition
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more