Struct ruma::api::client::relations::get_relating_events_with_rel_type::v1::Request

pub struct Request<'a> {
    pub room_id: &'a RoomId,
    pub event_id: &'a EventId,
    pub rel_type: RelationType,
    pub from: Option<&'a str>,
    pub to: Option<&'a str>,
    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.

Data for a request to the get_relating_events_with_rel_type API endpoint.

Get the child events for a given parent event, with a given relType.

Fields

room_id: &'a RoomId

The ID of the room containing the parent event.

event_id: &'a EventId

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

rel_type: RelationType

The relationship type to search for.

from: Option<&'a str>

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<&'a str>

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<'a> Request<'a>

pub fn new(
    room_id: &'a RoomId,
    event_id: &'a EventId,
    rel_type: RelationType
) -> Request<'a>

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

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> OutgoingRequest for Request<'a>

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

Metadata about the endpoint.

fn try_into_http_request<T>(
    self,
    base_url: &str,
    access_token: SendAccessToken<'_>,
    considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
    T: Default + BufMut,

Tries to convert this request into an http::Request.