Struct ruma_client_api::r0::contact::request_contact_verification_token::Request[−][src]

pub struct Request<'a> {
    pub client_secret: &'a str,
    pub email: &'a str,
    pub send_attempt: UInt,
    pub next_link: Option<&'a str>,
    pub id_server: Option<&'a str>,
    pub id_access_token: Option<&'a str>,
}
Expand description

Data for a request to the request_contact_verification_token API endpoint.

Ask for a verification token for a given 3rd party ID.

Fields

client_secret: &'a str

Client-generated secret string used to protect this session.

email: &'a str

The email address.

send_attempt: UInt

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

next_link: Option<&'a str>

A URL for the identity server to redirect the user to after validation is completed.

id_server: Option<&'a str>

The identity server to send the onward request to as a hostname with an appended colon and port number if the port is not the default.

id_access_token: Option<&'a str>

An access token previously registered with the identity server.

Required if an id_server is supplied.

Implementations

impl<'a> Request<'a>[src]

pub fn new(client_secret: &'a str, email: &'a str, send_attempt: UInt) -> Self[src]

Creates a new Request with the given client secret, email and send-attempt counter.

Trait Implementations

impl<'a> Clone for Request<'a>[src]

fn clone(&self) -> Request<'a>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<'a> Debug for Request<'a>[src]

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

Formats the value using the given formatter. Read more

impl<'a> Outgoing for Request<'a>[src]

type Incoming = IncomingRequest

The ‘Incoming’ variant of Self.

impl<'a> OutgoingRequest for Request<'a>[src]

type EndpointError = Error

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

type IncomingResponse = <Response as Outgoing>::Incoming

Response type returned when the request is successful.

const METADATA: Metadata[src]

Metadata about the endpoint.

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

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

impl<'a> OutgoingNonAuthRequest for Request<'a>[src]

Auto Trait Implementations

impl<'a> RefUnwindSafe for Request<'a>

impl<'a> Send for Request<'a>

impl<'a> Sync for Request<'a>

impl<'a> Unpin for Request<'a>

impl<'a> UnwindSafe for Request<'a>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> OutgoingRequestAppserviceExt for T where
    T: OutgoingRequest, [src]

fn try_into_http_request_with_user_id<T>(
    self,
    base_url: &str,
    access_token: SendAccessToken<'_>,
    user_id: UserId
) -> Result<Request<T>, IntoHttpError> where
    T: Default + BufMut, [src]

Tries to convert this request into an http::Request and appends a virtual user_id to assert Appservice identity. Read more

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.