Struct ReceiptsConfig

#[non_exhaustive]
pub struct ReceiptsConfig {
    pub enabled: Option<bool>,
    pub lists: Option<Vec<String>>,
    pub rooms: Option<Vec<RoomReceiptConfig>>,
}

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

Receipt extension configuration.

According to MSC3960

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.

enabled: Option<bool>

Activate or deactivate this extension. Sticky.

lists: Option<Vec<String>>

List of list names for which receipts should be enabled.

If not defined, will be enabled for all the lists appearing in the request. If defined and empty, will be disabled for all the lists.

Sticky.

rooms: Option<Vec<RoomReceiptConfig>>

List of room names for which receipts should be enabled.

If not defined, will be enabled for all the rooms appearing in the room_subscriptions. If defined and empty, will be disabled for all the rooms.

Sticky.

Implementations

impl ReceiptsConfig

pub fn is_empty(&self) -> bool

Available on crate feature experimental-sliding-sync only.

Whether all fields are empty or None.

Trait Implementations

impl Clone for ReceiptsConfig

fn clone(&self) -> ReceiptsConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiptsConfig

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

Formats the value using the given formatter.

impl Default for ReceiptsConfig

fn default() -> ReceiptsConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReceiptsConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Receipts> for ReceiptsConfig

Available on crate feature unstable-msc4186 only.

fn from(value: Receipts) -> ReceiptsConfig

Converts to this type from the input type.

impl PartialEq for ReceiptsConfig

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

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 StructuralPartialEq for ReceiptsConfig