Struct matrix_sdk::ruma::api::client::sync::sync_events::v5::request::RoomSubscription

#[non_exhaustive]
pub struct RoomSubscription {
    pub required_state: Vec<(StateEventType, String)>,
    pub timeline_limit: UInt,
    pub include_heroes: Option<bool>,
}

Available on crate feature api and (crate features client or server) and crate feature unstable-msc4186 only.

Sliding sync request room subscription (see super::Request::room_subscriptions).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

required_state: Vec<(StateEventType, String)>

Required state for each returned room. An array of event type and state key tuples.

timeline_limit: UInt

The maximum number of timeline events to return per room.

include_heroes: Option<bool>

Include the room heroes.

Trait Implementations

impl Clone for RoomSubscription

fn clone(&self) -> RoomSubscription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomSubscription

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

Formats the value using the given formatter.

impl Default for RoomSubscription

fn default() -> RoomSubscription

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RoomSubscription

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RoomSubscription> for RoomSubscription

fn from(value: RoomSubscription) -> RoomSubscription

Converts to this type from the input type.

impl Serialize for RoomSubscription

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.