Struct ruma_common::thirdparty::Protocol

pub struct Protocol {
    pub user_fields: Vec<String>,
    pub location_fields: Vec<String>,
    pub icon: String,
    pub field_types: BTreeMap<String, FieldType>,
    pub instances: Vec<ProtocolInstance>,
}

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

user_fields: Vec<String>

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

location_fields: Vec<String>

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 compat feature, this field being absent in JSON will result in an empty string here during deserialization.

field_types: BTreeMap<String, FieldType>

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

instances: Vec<ProtocolInstance>

A list of objects representing independent instances of configuration.

Trait Implementations

impl Clone for Protocol

fn clone(&self) -> Protocol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Protocol

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl From<ProtocolInit> for Protocol

fn from(init: ProtocolInit) -> Self

Converts to this type from the input type.

impl Serialize for Protocol

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.