Enum LoginProtocolData 

#[non_exhaustive]
pub enum LoginProtocolData {
    Msc4108DeviceAuthorizationGrant(AuthorizationGrant),
    Msc4388DeviceAuthorizationGrant(AuthorizationGrant),
    Unknown(UnknownLoginProtocol),
}

Available on crate feature e2e-encryption only.

The login protocol the new device has picked in a QrAuthMessage::LoginProtocol message, along with the data specific to that protocol.

On the wire, the protocol name is in the protocol field, and the protocol specific fields sit next to it, like other Matrix structures keyed on a discriminator field.

For the device_authorization_grant protocol, clients using the MSC4108 variant of the secure channel instead nest the data in a field named after the protocol, i.e. "protocol": "device_authorization_grant" comes with a "device_authorization_grant": { ... } field. Which layout is used depends on the variant of the secure channel.

Like other known message types, a known protocol only keeps the fields it knows about, while an UnknownLoginProtocol keeps all the fields, as we don’t know which ones are relevant.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Msc4108DeviceAuthorizationGrant(AuthorizationGrant)

The device_authorization_grant login protocol, as sent over the MSC4108 variant of the secure channel, with the data nested in a device_authorization_grant field.

Contains the device authorization grant the OAuth 2.0 server has given to the new device, with the URL the existing device should use to confirm the log in.

Msc4388DeviceAuthorizationGrant(AuthorizationGrant)

The device_authorization_grant login protocol, as sent over the MSC4388 variant of the secure channel, with the data next to the protocol field.

Contains the device authorization grant the OAuth 2.0 server has given to the new device, with the URL the existing device should use to confirm the log in.

Unknown(UnknownLoginProtocol)

An unknown and unsupported login protocol.

Implementations

impl LoginProtocolData

pub fn new(protocol: LoginProtocolType, data: JsonObject) -> Result<Self, Error>

Create a new LoginProtocolData from the given login protocol and its data.

The data contains the fields of the QrAuthMessage::LoginProtocol message other than type, protocol and device_id. If the protocol is a known one, the data is deserialized into the corresponding variant and only the fields that protocol knows about are kept. Otherwise a LoginProtocolData::Unknown is created, which keeps all the fields verbatim.

For the LoginProtocolType::DeviceAuthorizationGrant protocol, the layout is detected from the data: if it contains a device_authorization_grant field, a LoginProtocolData::Msc4108DeviceAuthorizationGrant is created, otherwise a LoginProtocolData::Msc4388DeviceAuthorizationGrant.

Returns an error if the protocol is a known one and the data is not valid for it, or if the protocol is unknown and the data contains one of the type, protocol or device_id fields, as they would clash with the fields of the message when serialized.

pub fn protocol(&self) -> LoginProtocolType

Get the login protocol.

Trait Implementations

impl Clone for LoginProtocolData

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LoginProtocolData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoginProtocolData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LoginProtocolData

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.