Struct Response

#[non_exhaustive]
pub struct Response {
    pub chunk: Vec<Raw<AnyTimelineEvent>>,
    pub next_batch: Option<String>,
}

Available on crate feature api and (crate features client or server) only.

Response type for the get_thread_roots 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<AnyTimelineEvent>>

The thread roots, ordered by the latest_event in each event’s aggregation bundle.

All events returned include bundled aggregations.

next_batch: Option<String>

An opaque string to provide to from to keep paginating the responses.

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

Implementations

impl Response

pub fn new(chunk: Vec<Raw<AnyTimelineEvent>>) -> Response

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<(), Error>

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>( response: Response<T>, ) -> Result<Response, FromHttpResponseError<Error>>

where T: AsRef<[u8]>,

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