Struct ThreePidOwnershipProof

#[non_exhaustive]
pub struct ThreePidOwnershipProof {
    pub sid: OwnedSessionId,
    pub client_secret: OwnedClientSecret,
}

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

A proof that the client owns the 3PID.

Must be constructed using the same session ID and client secret generated and passed by the requestToken call for the given 3PID.

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.

sid: OwnedSessionId

The Session ID generated by the requestToken call.

client_secret: OwnedClientSecret

The client secret passed to the requestToken call.

Implementations

impl ThreePidOwnershipProof

pub fn new( sid: OwnedSessionId, client_secret: OwnedClientSecret, ) -> ThreePidOwnershipProof

Creates a new ThreePidOwnershipProof with the given session ID and client secret.

Trait Implementations

impl Clone for ThreePidOwnershipProof

fn clone(&self) -> ThreePidOwnershipProof

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ThreePidOwnershipProof

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ThreePidOwnershipProof

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ThreePidOwnershipProof

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.