Struct ruma_client_api::account::change_password::v3::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub new_password: &'a str,
    pub logout_devices: bool,
    pub auth: Option<AuthData<'a>>,
}

Data for a request to the change_password API endpoint.

Change the password of the current user’s account.

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

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<'a>>

Additional authentication information for the user-interactive authentication API.

Implementations

impl<'a> Request<'a>

pub fn new(new_password: &'a str) -> Self

Creates a new Request with the given password.

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 = UiaaResponse

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.