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

pub struct Request {
    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.

Request type for the set_read_marker endpoint.

Fields

room_id: OwnedRoomId

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

fully_read: Option<OwnedEventId>

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.

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>

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

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

Implementations

impl Request

pub fn new(room_id: OwnedRoomId) -> Request

Creates a new Request with the given room 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 IncomingRequest for Request

Available on crate feature server only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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 OutgoingRequest for Request

Available on crate feature client only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut,

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