Struct Request

#[non_exhaustive]
pub struct Request {
    pub client_secret: OwnedClientSecret,
    pub country: String,
    pub phone_number: String,
    pub send_attempt: UInt,
    pub next_link: Option<String>,
    pub identity_server_info: Option<IdentityServerInfo>,
}

Available on crate features client or server only.

Request type for the request_3pid_management_token_via_msisdn endpoint.

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.

client_secret: OwnedClientSecret

Client-generated secret string used to protect this session.

country: String

Two-letter ISO 3166 country code for the phone number.

phone_number: String

Phone number to validate.

send_attempt: UInt

Used to distinguish protocol level retries from requests to re-send the SMS.

next_link: Option<String>

Return URL for identity server to redirect the client back to.

identity_server_info: Option<IdentityServerInfo>

👎Deprecated: Since Matrix Client-Server API r0.6.0.

Optional identity server hostname and access token.

Implementations

impl Request

pub fn new( client_secret: OwnedClientSecret, country: String, phone_number: String, send_attempt: UInt, ) -> Self

Creates a new Request with the given client secret, country code, phone number and send-attempt counter.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl IncomingRequest for Request

Available on crate feature server only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = Error

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S], ) -> Result<Self, FromHttpRequestError>

where B: AsRef<[u8]>, S: AsRef<str>,

Tries to turn the given http::Request into this request type, together with the corresponding path arguments.

impl OutgoingRequest for Request

Available on crate feature client only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = Error

A type capturing the expected error conditions the server can return.

type IncomingResponse = Response

Response type returned when the request is successful.

fn try_into_http_request<T: Default + BufMut>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

Tries to convert this request into an http::Request.