Struct ruma_client_api::relations::get_relating_events_with_rel_type_and_event_type::v1::Response

pub struct Response {
    pub chunk: Vec<Raw<AnyMessageLikeEvent>>,
    pub next_batch: Option<String>,
    pub prev_batch: Option<String>,
}

Available on crate features client or server only.

Response type for the get_relating_events_with_rel_type_and_event_type endpoint.

Fields

chunk: Vec<Raw<AnyMessageLikeEvent>>

The paginated child events which point to the parent.

The events returned will match the rel_type and even_type supplied in the URL and 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.

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

Available on crate feature client only.

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.

impl OutgoingResponse for Response

Available on crate feature server only.

fn try_into_http_response<T: Default + BufMut>( self ) -> Result<Response<T>, IntoHttpError>

Tries to convert this response into an http::Response.