Struct ruma_client_api::account::bind_3pid::v3::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub client_secret: &'a ClientSecret,
    pub identity_server_info: IdentityServerInfo<'a>,
    pub sid: &'a SessionId,
}

Data for a request to the bind_3pid API endpoint.

Bind a 3PID to a user’s account on an identity server

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: &'a ClientSecret

Client-generated secret string used to protect this session.

identity_server_info: IdentityServerInfo<'a>

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

sid: &'a SessionId

The session identifier given by the identity server.

Implementations

impl<'a> Request<'a>

pub fn new(
    client_secret: &'a ClientSecret,
    identity_server_info: IdentityServerInfo<'a>,
    sid: &'a SessionId
) -> Self

Creates a new Request with the given client secret, identity server information and session identifier.

Trait Implementations

impl<'a> Clone for Request<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> OutgoingRequest for Request<'a>

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.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

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.