#[non_exhaustive]pub struct StickyEvents {
pub enabled: bool,
pub limit: Option<UInt>,
pub lists: Option<Vec<String>>,
pub rooms: Option<Vec<OwnedRoomId>>,
}Available on crate feature
api and crate feature unstable-msc4186 and crate feature unstable-msc4480 and (crate features client-api-c or client-api-s) and (crate features client or server) only.Expand description
Sticky events extension configuration.
According to MSC4480.
Fields (Non-exhaustive)§
This struct is marked as 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: boolWhether this extension is enabled.
limit: Option<UInt>Maximum number of sticky events to return per response.
Defaults to 100 (server-side) and the server may override it to a lower value.
lists: Option<Vec<String>>The keys of the lists the extension applies to.
None means all the lists, and an empty list means none of them.
rooms: Option<Vec<OwnedRoomId>>The room subscriptions the extension applies to.
None means all the room subscriptions, and an empty list means none of them.
Implementations§
Source§impl StickyEvents
impl StickyEvents
Sourcepub fn new() -> StickyEvents
pub fn new() -> StickyEvents
Creates a disabled StickyEvents.
Sourcepub fn is_disabled(&self) -> bool
pub fn is_disabled(&self) -> bool
Whether this extension is disabled.
Trait Implementations§
Source§impl Clone for StickyEvents
impl Clone for StickyEvents
Source§fn clone(&self) -> StickyEvents
fn clone(&self) -> StickyEvents
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for StickyEvents
impl Debug for StickyEvents
Source§impl Default for StickyEvents
impl Default for StickyEvents
Source§fn default() -> StickyEvents
fn default() -> StickyEvents
Returns the “default value” for a type. Read more
Source§impl<'de> Deserialize<'de> for StickyEvents
impl<'de> Deserialize<'de> for StickyEvents
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<StickyEvents, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<StickyEvents, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl PartialEq for StickyEvents
impl PartialEq for StickyEvents
Source§impl Serialize for StickyEvents
impl Serialize for StickyEvents
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
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. Read more
impl StructuralPartialEq for StickyEvents
Auto Trait Implementations§
impl Forget for StickyEvents
impl Freeze for StickyEvents
impl Move for StickyEvents
impl RefUnwindSafe for StickyEvents
impl Send for StickyEvents
impl Sync for StickyEvents
impl Unpin for StickyEvents
impl UnsafeUnpin for StickyEvents
impl UnwindSafe for StickyEvents
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more