Struct Response

#[non_exhaustive]
pub struct Response {
    pub start: Option<String>,
    pub end: Option<String>,
    pub events_before: Vec<Raw<AnyTimelineEvent>>,
    pub event: Option<Raw<AnyTimelineEvent>>,
    pub events_after: Vec<Raw<AnyTimelineEvent>>,
    pub state: Vec<Raw<AnyStateEvent>>,
}

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

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

start: Option<String>

A token that can be used to paginate backwards with.

end: Option<String>

A token that can be used to paginate forwards with.

events_before: Vec<Raw<AnyTimelineEvent>>

A list of room events that happened just before the requested event, in reverse-chronological order.

event: Option<Raw<AnyTimelineEvent>>

Details of the requested event.

events_after: Vec<Raw<AnyTimelineEvent>>

A list of room events that happened just after the requested event, in chronological order.

state: Vec<Raw<AnyStateEvent>>

The state of the room at the last event returned.

Implementations

impl Response

pub fn new() -> Response

Creates an empty Response.

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 Default for Response

fn default() -> Response

Returns the “default value” for a type.

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.