Struct Receipts

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

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

Receipt extension.

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.

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.

rooms: Option<Vec<ReceiptsRoom>>

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.

Implementations

impl Receipts

pub fn is_empty(&self) -> bool

Whether all fields are empty or None.

Trait Implementations

impl Clone for Receipts

fn clone(&self) -> Receipts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Receipts

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

Formats the value using the given formatter.

impl Default for Receipts

fn default() -> Receipts

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Receipts

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Receipts> for ReceiptsConfig

fn from(value: Receipts) -> ReceiptsConfig

Converts to this type from the input type.

impl PartialEq for Receipts

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

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 Receipts