Struct Request 

#[non_exhaustive]
pub struct Request {
    pub room_id: OwnedRoomId,
    pub event_id: OwnedEventId,
    pub txn_id: OwnedTransactionId,
    pub reason: Option<String>,
}

Available on crate feature api and (crate features client-api-c or client-api-s) only.

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

room_id: OwnedRoomId

The ID of the room of the event to redact.

event_id: OwnedEventId

The ID of the event to redact.

txn_id: OwnedTransactionId

The transaction ID for this event.

Clients should generate a unique ID across requests within the same session. A session is identified by an access token, and persists when the access token is refreshed.

It will be used by the server to ensure idempotency of requests.

reason: Option<String>

The reason for the redaction.

Implementations

impl Request

pub fn new( room_id: OwnedRoomId, event_id: OwnedEventId, txn_id: OwnedTransactionId, ) -> Request

Creates a new Request with the given room ID, event ID and transaction ID.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl IncomingRequest for Request

type EndpointError = Error

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<Request, 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 Metadata for Request

const METHOD: Method = ::ruma_common::exports::http::Method::PUT

The HTTP method used by this endpoint.

const RATE_LIMITED: bool = false

Whether or not this endpoint is rate limited by the server.

const HISTORY: VersionHistory

All info pertaining to an endpoint’s (historic) paths, deprecation version, and removal.

type Authentication = AccessToken

What authentication scheme the server uses for this endpoint.

fn empty_request_body<B>() -> B

where B: Default + BufMut,

Returns an empty request body for this Matrix request.

fn make_endpoint_url( considering: &SupportedVersions, base_url: &str, path_args: &[&dyn Display], query_string: &str, ) -> Result<String, IntoHttpError>

Generate the endpoint URL for this endpoint.

impl OutgoingRequest for Request

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.

fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering: &SupportedVersions, ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut,

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

fn is_supported(considering_versions: &SupportedVersions) -> bool

Whether the homeserver advertises support for this endpoint.