Struct Request

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

Request type for the create_email_validation_session 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

A unique string generated by the client, and used to identify the validation attempt.

email: String

The email address to validate.

send_attempt: UInt

The server will only send an email if the send_attempt is a number greater than the most recent one which it has seen, scoped to that email + client_secret pair.

next_link: Option<String>

When the validation is completed, the identity server will redirect the user to this URL.

Implementations

impl Request

pub fn new( client_secret: OwnedClientSecret, email: String, send_attempt: UInt, next_link: Option<String>, ) -> Self

Create a new Request with the given client secret, email ID, send_attempt number, and the link to redirect to after validation.

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

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = MatrixError

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

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = MatrixError

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.