Struct matrix_sdk_common::thirdparty::Protocol

#[non_exhaustive]pub struct Protocol {
    pub user_fields: Vec<String, Global>,
    pub location_fields: Vec<String, Global>,
    pub icon: String,
    pub field_types: BTreeMap<String, FieldType>,
    pub instances: Vec<ProtocolInstance, Global>,
}

Metadata about a third party protocol.

To create an instance of this type, first create a ProtocolInit and convert it via Protocol::from / .into().

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.

user_fields: Vec<String, Global>

Fields which may be used to identify a third party user.

location_fields: Vec<String, Global>

Fields which may be used to identify a third party location.

icon: String

A content URI representing an icon for the third party protocol.

If you activate the unstable-synapse-quirks feature, this field being absent in JSON will give you an empty string here.

field_types: BTreeMap<String, FieldType>

The type definitions for the fields defined in user_fields and location_fields.

instances: Vec<ProtocolInstance, Global>

A list of objects representing independent instances of configuration.

Trait Implementations

impl Clone for Protocol

pub fn clone(&self) -> Protocol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Protocol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Protocol

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

Deserialize this value from the given Serde deserializer.

impl From<ProtocolInit> for Protocol

pub fn from(init: ProtocolInit) -> Protocol

Performs the conversion.

impl Serialize for Protocol

pub 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.