Struct ruma::api::client::r0::message::get_message_events::IncomingRequest [−][src]
pub struct IncomingRequest {
pub room_id: RoomId,
pub from: String,
pub to: Option<String>,
pub dir: Direction,
pub limit: UInt,
pub filter: Option<IncomingRoomEventFilter>,
}
api
and (crate features client-api
or client-api-c
or client-api-s
) only.Expand description
‘Incoming’ variant of Request.
Fields
room_id: RoomId
The room to get events from.
from: String
The token to start returning events from.
This token can be obtained from a prev_batch token returned for each room by the sync API, or from a start or end token returned by a previous request to this endpoint.
to: Option<String>
The token to stop returning events at.
This token can be obtained from a prev_batch token returned for each room by the sync endpoint, or from a start or end token returned by a previous request to this endpoint.
dir: Direction
The direction to return events from.
limit: UInt
The maximum number of events to return.
Default: 10.
filter: Option<IncomingRoomEventFilter>
A RoomEventFilter to filter returned events with.
Trait Implementations
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.
pub fn try_from_http_request<T>(
request: Request<T>
) -> Result<IncomingRequest, FromHttpRequestError> where
T: AsRef<[u8]>,
pub fn try_from_http_request<T>(
request: Request<T>
) -> Result<IncomingRequest, FromHttpRequestError> where
T: AsRef<[u8]>,
Tries to turn the given http::Request
into this request type.
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
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more