Struct ruma_client_api::read_marker::set_read_marker::v3::IncomingRequest
source · [−]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
or server
only.Expand description
‘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
sourceimpl Debug for IncomingRequest
impl Debug for IncomingRequest
sourceimpl IncomingRequest for IncomingRequest
Available on crate feature server
only.
impl IncomingRequest for IncomingRequest
Available on crate feature
server
only.type EndpointError = Error
type EndpointError = Error
A type capturing the error conditions that can be returned in the response.
type OutgoingResponse = Response
type OutgoingResponse = Response
Response type to return when the request is successful.
Auto Trait Implementations
impl RefUnwindSafe for IncomingRequest
impl Send for IncomingRequest
impl Sync for IncomingRequest
impl Unpin for IncomingRequest
impl UnwindSafe for IncomingRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more