Struct Profiles 

#[non_exhaustive]
pub struct Profiles {
    pub enabled: Option<bool>,
    pub lists: Option<Vec<String>>,
    pub rooms: Option<Vec<ExtensionRoomConfig>>,
    pub fields: Option<Vec<ProfileFieldName>>,
    pub include_history: Option<bool>,
}

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

User profiles extension.

Specified as part of MSC4262.

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 user profiles 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<ExtensionRoomConfig>>

List of room names for which user profiles 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.

fields: Option<Vec<ProfileFieldName>>

Optional filter to control which profile fields to receive updates for. If omitted, all profile field updates are included.

include_history: Option<bool>

Optional flag to control whether the initial sync includes recent historical profile changes:

If false (default), only current profile states are sent on initial sync. If true, the server may include recent profile changes that occurred before the sync.

Implementations

impl Profiles

pub fn is_empty(&self) -> bool

Whether all fields are empty or None.

Trait Implementations

impl Clone for Profiles

fn clone(&self) -> Profiles

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Profiles

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

Formats the value using the given formatter.

impl Default for Profiles

fn default() -> Profiles

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Profiles

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Profiles

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

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 Profiles