Struct ruma_client_api::context::get_context::v3::Request

#[non_exhaustive]
pub struct Request {
    pub room_id: OwnedRoomId,
    pub event_id: OwnedEventId,
    pub limit: UInt,
    pub filter: RoomEventFilter,
}

Request type for the get_context endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

room_id: OwnedRoomId

The room to get events from.

event_id: OwnedEventId

The event to get context around.

limit: UInt

The maximum number of context events to return.

This limit applies to the sum of the events_before and events_after arrays. The requested event ID is always returned in event even if the limit is 0.

Defaults to 10.

filter: RoomEventFilter

A RoomEventFilter to filter returned events with.

Implementations

impl Request

pub fn new(room_id: OwnedRoomId, event_id: OwnedEventId) -> Self

Creates a new Request with the given room id and event id.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl OutgoingRequest for Request

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.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.