Enum ruma::api::client::filter::EventFormat

#[non_exhaustive]
pub enum EventFormat {
    Client,
    Federation,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

Format to use for returned events.

This type can hold an arbitrary string. To build this with a custom value, convert it from a string with ::from() / .into(). To check for values that are not available as a documented variant here, use its string representation, obtained through .as_str().

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Client

Client format, as described in the Client API.

Federation

Raw events from federation.

Implementations

impl EventFormat

pub fn as_str(&self) -> &str

Creates a string slice from this EventFormat.

Trait Implementations

impl AsRef<str> for EventFormat

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for EventFormat

fn clone(&self) -> EventFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventFormat

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

Formats the value using the given formatter.

impl Default for EventFormat

fn default() -> EventFormat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EventFormat

fn deserialize<D>( deserializer: D, ) -> Result<EventFormat, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EventFormat

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

Formats the value using the given formatter.

impl<T> From<T> for EventFormat

where T: AsRef<str> + Into<Box<str>>,

fn from(s: T) -> EventFormat

Converts to this type from the input type.

impl PartialEq for EventFormat

fn eq(&self, other: &EventFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for EventFormat

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.

impl Eq for EventFormat

impl StructuralPartialEq for EventFormat