Struct ruma_client_api::relations::get_relating_events_with_rel_type_and_event_type::v1::Request

pub struct Request {
    pub room_id: OwnedRoomId,
    pub event_id: OwnedEventId,
    pub rel_type: RelationType,
    pub event_type: TimelineEventType,
    pub from: Option<String>,
    pub to: Option<String>,
    pub limit: Option<UInt>,
}

Available on crate features client or server only.

Request type for the get_relating_events_with_rel_type_and_event_type endpoint.

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.

rel_type: RelationType

The relationship type to search for.

event_type: TimelineEventType

The event type of child events to search for.

Note that in encrypted rooms this will typically always be m.room.encrypted regardless of the event type contained within the encrypted payload.

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.

Implementations

impl Request

pub fn new( room_id: OwnedRoomId, event_id: OwnedEventId, rel_type: RelationType, event_type: TimelineEventType ) -> Self

Creates a new Request with the given room ID, parent event ID, relationship type and event type.

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 IncomingRequest for Request

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 = METADATA

Metadata about the endpoint.

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

impl OutgoingRequest for Request

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.

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.