Struct ruma_client_api::relations::get_relating_events::v1::Response

#[non_exhaustive]
pub struct Response {
    pub chunk: Vec<Raw<AnyMessageLikeEvent>>,
    pub next_batch: Option<String>,
    pub prev_batch: Option<String>,
    pub recursion_depth: Option<UInt>,
}

Response type for the get_relating_events 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.

chunk: Vec<Raw<AnyMessageLikeEvent>>

The paginated child events which point to the parent.

The events returned are ordered topologically, most-recent first.

If no events are related to the parent or the pagination yields no results, an empty chunk is returned.

next_batch: Option<String>

An opaque string representing a pagination token.

If this is None, there are no more results to fetch and the client should stop paginating.

prev_batch: Option<String>

An opaque string representing a pagination token.

If this is None, this is the start of the result set, i.e. this is the first batch/page.

recursion_depth: Option<UInt>

If recurse was set on the request, the depth to which the server recursed.

If recurse was not set, this field must be absent.

Implementations

impl Response

pub fn new(chunk: Vec<Raw<AnyMessageLikeEvent>>) -> Self

Creates a new Response with the given chunk.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl IncomingResponse for Response

type EndpointError = Error

A type capturing the expected error conditions the server can return.

fn try_from_http_response<T: AsRef<[u8]>>( response: Response<T>, ) -> Result<Self, FromHttpResponseError<Error>>

Tries to convert the given http::Response into this response type.