Struct Request

#[non_exhaustive]
pub struct Request {
    pub new_password: String,
    pub logout_devices: bool,
    pub auth: Option<AuthData>,
}

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

new_password: String

The new password for the account.

logout_devices: bool

True to revoke the user’s other access tokens, and their associated devices if the request succeeds.

Defaults to true.

When false, the server can still take advantage of the soft logout method for the user’s remaining devices.

auth: Option<AuthData>

Additional authentication information for the user-interactive authentication API.

Implementations

impl Request

pub fn new(new_password: String) -> Self

Creates a new Request with the given password.

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 OutgoingRequest for Request

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = UiaaResponse

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.