Struct ruma::api::federation::directory::get_public_rooms_filtered::v1::Response

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

This is supported on crate feature api and (crate features federation-api or federation-api-c or federation-api-s) only.

Data in the response from the get_public_rooms_filtered API endpoint.

Fields

chunk: Vec<PublicRoomsChunk, Global>

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

Creates an empty Response.

Trait Implementations

impl Clone for Response

pub 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

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Response

pub fn default() -> Response

Returns the “default value” for a type.

impl IncomingResponse for Response

type EndpointError = MatrixError

A type capturing the expected error conditions the server can return.

pub fn try_from_http_response<T>(
    response: Response<T>
) -> Result<Response, FromHttpResponseError<MatrixError>> where
    T: AsRef<[u8]>, 

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

impl Outgoing for Response

type Incoming = Response

The ‘Incoming’ variant of Self.

impl OutgoingResponse for Response

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

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