Struct ruma_client_api::directory::get_public_rooms::v3::Response

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

Response type for the get_public_rooms 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<PublicRoomsChunk>

A paginated chunk of public rooms.

next_batch: Option<String>

A pagination token for the response.

prev_batch: Option<String>

A pagination token that allows fetching previous results.

total_room_count_estimate: Option<UInt>

An estimate on the total number of public rooms, if the server has an estimate.

Implementations

impl Response

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

Creates a new Response with the given room list 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.