Enum StateEventFormat

#[non_exhaustive]
pub enum StateEventFormat {
    Content,
    Event,
}

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

The format to use for the returned data.

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.

Content

Will return only the content of the state event.

This is the default value if the format is unspecified in the request.

Event

Will return the entire event in the usual format suitable for clients, including fields like event ID, sender and timestamp.

Trait Implementations

impl Clone for StateEventFormat

fn clone(&self) -> StateEventFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateEventFormat

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

Formats the value using the given formatter.

impl Default for StateEventFormat

fn default() -> StateEventFormat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StateEventFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StateEventFormat

fn eq(&self, other: &StateEventFormat) -> 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 StateEventFormat

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 Copy for StateEventFormat

impl StructuralPartialEq for StateEventFormat