Struct ruma::api::client::relations::get_relating_events::v1::IncomingRequest

pub struct IncomingRequest {
    pub room_id: OwnedRoomId,
    pub event_id: OwnedEventId,
    pub from: Option<String>,
    pub to: Option<String>,
    pub limit: Option<UInt>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

‘Incoming’ variant of Request.

Fields

room_id: OwnedRoomId

The ID of the room containing the parent event.

event_id: OwnedEventId

The ID of the parent event whose child events are to be returned.

from: Option<String>

The pagination token to start returning results from.

If None, results start at the most recent topological event known to the server.

Can be a next_batch token from a previous call, or a returned start token from /messages or a next_batch token from /sync.

Note that when paginating the from token should be “after” the to token in terms of topological ordering, because it is only possible to paginate “backwards” through events, starting at from.

to: Option<String>

The pagination token to stop returning results at.

If None, results continue up to limit or until there are no more events.

Like from, this can be a previous token from a prior call to this endpoint or from /messages or /sync.

limit: Option<UInt>

The maximum number of results to return in a single chunk.

The server can and should apply a maximum value to this parameter to avoid large responses.

Similarly, the server should apply a default value when not supplied.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

Available on crate feature server only.

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.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>(
    request: Request<B>,
    path_args: &[S]
) -> Result<IncomingRequest, 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.