Struct Request

pub struct Request<'a> {
    pub room_id: &'a RoomId,
    pub fully_read: Option<&'a EventId>,
    pub read_receipt: Option<&'a EventId>,
    pub private_read_receipt: Option<&'a EventId>,
}

Available on crate features client or server only.

Data for a request to the set_read_marker API endpoint.

Sets the position of the read marker for a given room, and optionally the read receipt’s location.

Fields

room_id: &'a RoomId

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

fully_read: Option<&'a EventId>

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<&'a EventId>

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<&'a EventId>

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.

Implementations

impl<'a> Request<'a>

pub fn new(room_id: &'a RoomId) -> Self

Available on crate feature unstable-msc2285 only.

Creates a new Request with the given room ID.

Without the unstable-msc2285 feature, this method takes a fully_read parameter.

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

Available on crate feature client only.

const METADATA: Metadata = self::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: Default + BufMut>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

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