Struct ProtocolInstance 

#[non_exhaustive]
pub struct ProtocolInstance {
    pub desc: String,
    pub icon: Option<String>,
    pub fields: BTreeMap<String, String>,
    pub network_id: String,
    pub instance_id: Option<String>,
}

Metadata about an instance of a third party protocol, as returned by a homeserver to a client.

To create an instance of this type, first create a ProtocolInstanceInit or an AppserviceProtocolInstance and convert it via ProtocolInstance::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.

desc: String

A human-readable description for the protocol, such as the name.

icon: Option<String>

An optional content URI representing the protocol.

fields: BTreeMap<String, String>

Preset values for fields the client may use to search by.

network_id: String

A unique identifier across all instances.

instance_id: Option<String>

A unique identifier for this instance on the homeserver.

This is a field added by the homeserver to AppserviceProtocolInstance. It can be used as the value of RoomNetwork::ThirdParty in a request to the get_public_rooms_filtered endpoint.

Trait Implementations

impl Clone for ProtocolInstance

fn clone(&self) -> ProtocolInstance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolInstance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtocolInstance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AppserviceProtocolInstance> for ProtocolInstance

fn from(value: AppserviceProtocolInstance) -> ProtocolInstance

Converts to this type from the input type.

impl From<ProtocolInstanceInit> for ProtocolInstance

fn from(init: ProtocolInstanceInit) -> ProtocolInstance

Converts to this type from the input type.

impl Serialize for ProtocolInstance

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.