Struct ruma_client_api::filter::FilterDefinition
source · [−]pub struct FilterDefinition<'a> {
pub event_fields: Option<&'a [String]>,
pub event_format: EventFormat,
pub presence: Filter<'a>,
pub account_data: Filter<'a>,
pub room: RoomFilter<'a>,
}
Available on crate features
client
or server
only.Expand description
A filter definition
Fields
event_fields: Option<&'a [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: Filter<'a>
The presence updates to include.
account_data: Filter<'a>
The user account data that isn’t associated with rooms to include.
room: RoomFilter<'a>
Filters to be applied to room data.
Implementations
sourceimpl<'a> FilterDefinition<'a>
impl<'a> FilterDefinition<'a>
Trait Implementations
sourceimpl<'a> CanBeEmpty for FilterDefinition<'a>
impl<'a> CanBeEmpty for FilterDefinition<'a>
sourceimpl<'a> Clone for FilterDefinition<'a>
impl<'a> Clone for FilterDefinition<'a>
sourcefn clone(&self) -> FilterDefinition<'a>
fn clone(&self) -> FilterDefinition<'a>
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<'a> Debug for FilterDefinition<'a>
impl<'a> Debug for FilterDefinition<'a>
sourceimpl<'a> Default for FilterDefinition<'a>
impl<'a> Default for FilterDefinition<'a>
sourcefn default() -> FilterDefinition<'a>
fn default() -> FilterDefinition<'a>
Returns the “default value” for a type. Read more
sourceimpl<'a> From<FilterDefinition<'a>> for Filter<'a>
impl<'a> From<FilterDefinition<'a>> for Filter<'a>
sourcefn from(def: FilterDefinition<'a>) -> Self
fn from(def: FilterDefinition<'a>) -> Self
Converts to this type from the input type.
sourceimpl<'a> Serialize for FilterDefinition<'a>
impl<'a> Serialize for FilterDefinition<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for FilterDefinition<'a>
impl<'a> Send for FilterDefinition<'a>
impl<'a> Sync for FilterDefinition<'a>
impl<'a> Unpin for FilterDefinition<'a>
impl<'a> UnwindSafe for FilterDefinition<'a>
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