Struct Protocol

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

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>

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 the compat-optional feature is enabled, this field being absent in JSON will result in an empty string instead of an error when deserializing.

field_types: BTreeMap<String, FieldType>

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

instances: Vec<I>

A list of objects representing independent instances of configuration.

Implementations

impl<I> Protocol<I>

pub fn into<J>(self) -> Protocol<J>

where J: From<I>,

Available on crate feature api and (crate features appservice-api-c or appservice-api-s) only.

Convert this Protocol<I> to a Protocol<J>.

Trait Implementations

impl<I> Clone for Protocol<I>

where I: Clone,

fn clone(&self) -> Protocol<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Debug for Protocol<I>

where I: Debug,

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

Formats the value using the given formatter.

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

where I: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<I> From<ProtocolInit<I>> for Protocol<I>

fn from(init: ProtocolInit<I>) -> Protocol<I>

Converts to this type from the input type.

impl<I> Serialize for Protocol<I>

where I: Serialize,

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.