Struct ruma_client_api::read_marker::set_read_marker::v3::Request

source · [−]

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.

Expand description

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

source

impl<'a> Request<'a>

source

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

source

impl<'a> Clone for Request<'a>

source

fn clone(&self) -> Request<'a>

Returns a copy of the value. Read more

1.0.0 · source

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl<'a> Debug for Request<'a>

source

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

Formats the value using the given formatter. Read more

source

impl<'a> OutgoingRequest for Request<'a>

Available on crate feature client only.

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.

source

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

source

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. Read more

Auto Trait Implementations

impl<'a> RefUnwindSafe for Request<'a>

impl<'a> Send for Request<'a>

impl<'a> Sync for Request<'a>

impl<'a> Unpin for Request<'a>

impl<'a> UnwindSafe for Request<'a>

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,

source

fn try_into_http_request_with_user_id<T>(
 self,
 base_url: &str,
 access_token: SendAccessToken<'_>,
 user_id: &UserId,
 considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
 T: Default + BufMut,

Tries to convert this request into an http::Request and appends a virtual user_id to assert Appservice identity. Read more

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct ruma_client_api::read_marker::set_read_marker::v3::Request

Fields

Implementations

impl<'a> Request<'a>

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

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

const fn clone_from(&mut self, source: &Self)

impl<'a> Debug for Request<'a>

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

impl<'a> OutgoingRequest for Request<'a>

type EndpointError = Error

type IncomingResponse = Response

const METADATA: Metadata = self::METADATA

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

Auto Trait Implementations

impl<'a> RefUnwindSafe for Request<'a>

impl<'a> Send for Request<'a>

impl<'a> Sync for Request<'a>

impl<'a> Unpin for Request<'a>

impl<'a> UnwindSafe for Request<'a>

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> OutgoingRequestAppserviceExt for Twhere T: OutgoingRequest,

fn try_into_http_request_with_user_id<T>( self, base_url: &str, access_token: SendAccessToken<'_>, user_id: &UserId, considering_versions: &[MatrixVersion]) -> Result<Request<T>, IntoHttpError>where T: Default + BufMut,

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,

fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: &UserId,
considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
T: Default + BufMut,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,