Struct ruma_client_api::r0::redact::redact_event::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub room_id: &'a RoomId,
    pub event_id: &'a EventId,
    pub txn_id: &'a str,
    pub reason: Option<&'a str>,
}

Data for a request to the redact_event API endpoint.

Redact an event, stripping all information not critical to the event graph integrity.

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

The ID of the room of the event to redact.

event_id: &'a EventId

The ID of the event to redact.

txn_id: &'a str

The transaction ID for this event.

Clients should generate a unique ID; it will be used by the server to ensure idempotency of requests.

reason: Option<&'a str>

The reason for the redaction.

Implementations

impl<'a> Request<'a>

pub fn new(room_id: &'a RoomId, event_id: &'a EventId, txn_id: &'a str) -> Self

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

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> Outgoing for Request<'a>

type Incoming = IncomingRequest

The ‘Incoming’ variant of Self.