Struct matrix_sdk_base::ruma::api::client::receipt::create_receipt::v3::Request

#[non_exhaustive]
pub struct Request {
    pub room_id: OwnedRoomId,
    pub receipt_type: ReceiptType,
    pub event_id: OwnedEventId,
    pub thread: ReceiptThread,
}

Request type for the create_receipt 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 room in which to send the event.

receipt_type: ReceiptType

The type of receipt to send.

event_id: OwnedEventId

The event ID to acknowledge up to.

thread: ReceiptThread

The thread this receipt applies to.

Note that this must be the default value if used with ReceiptType::FullyRead.

Defaults to ReceiptThread::Unthreaded.

Implementations

impl Request

pub fn new( room_id: OwnedRoomId, receipt_type: ReceiptType, event_id: OwnedEventId, ) -> Request

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

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

Formats the value using the given formatter.

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.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut,

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