Struct Registration 

#[non_exhaustive]
pub struct Registration {
    pub id: String,
    pub url: Option<String>,
    pub as_token: String,
    pub hs_token: String,
    pub sender_localpart: String,
    pub namespaces: Namespaces,
    pub rate_limited: Option<bool>,
    pub protocols: Option<Vec<String>>,
    pub receive_ephemeral: bool,
}

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

Information required in the registration yaml file that a homeserver needs.

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

Used for appservice registration.

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.

id: String

A unique, user - defined ID of the application service which will never change.

url: Option<String>

The URL for the application service.

Optionally set to null if no traffic is required.

as_token: String

A unique token for application services to use to authenticate requests to Homeservers.

hs_token: String

A unique token for Homeservers to use to authenticate requests to application services.

sender_localpart: String

The localpart of the user associated with the application service.

namespaces: Namespaces

A list of users, aliases and rooms namespaces that the application service controls.

rate_limited: Option<bool>

Whether requests from masqueraded users are rate-limited.

The sender is excluded.

protocols: Option<Vec<String>>

The external protocols which the application service provides (e.g. IRC).

receive_ephemeral: bool

Whether the application service wants to receive ephemeral data.

Defaults to false.

Trait Implementations

impl Clone for Registration

fn clone(&self) -> Registration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Registration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Registration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RegistrationInit> for Registration

fn from(init: RegistrationInit) -> Registration

Converts to this type from the input type.

impl Serialize for Registration

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.