Struct ruma::api::client::read_marker::set_read_marker::v3::IncomingRequest

pub struct IncomingRequest {
    pub room_id: OwnedRoomId,
    pub fully_read: Option<OwnedEventId>,
    pub read_receipt: Option<OwnedEventId>,
    pub private_read_receipt: Option<OwnedEventId>,
}

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

‘Incoming’ variant of Request.

Fields

room_id: OwnedRoomId

The room ID to set the read marker in for the user.

fully_read: Option<OwnedEventId>

Available on crate feature unstable-msc2285 only.

The event ID the fully-read marker should be located at.

The event MUST belong to the room.

This is equivalent to calling the create_receipt endpoint with a ReceiptType::FullyRead.

Without the unstable-msc2285 feature, this field is required.

read_receipt: Option<OwnedEventId>

The event ID to set the public read receipt location at.

This is equivalent to calling the create_receipt endpoint with a ReceiptType::Read.

private_read_receipt: Option<OwnedEventId>

Available on crate feature unstable-msc2285 only.

The event ID to set the private read receipt location at.

This is equivalent to calling the create_receipt endpoint with a ReceiptType::ReadPrivate.

Trait Implementations

impl Debug for IncomingRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

Available on crate feature server only.

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.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>(
    request: Request<B>,
    path_args: &[S]
) -> Result<IncomingRequest, 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.