Struct ruma_client_api::directory::get_public_rooms_filtered::v3::Response

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

Available on crate features client or server only.

Response type for the get_public_rooms_filtered endpoint.

Fields

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() -> Self

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

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: 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.