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

pub struct Request<'a> {
    pub limit: Option<UInt>,
    pub since: Option<&'a str>,
    pub filter: Filter<'a>,
    pub room_network: RoomNetwork<'a>,
}

Available on crate feature api and (crate features federation-api-c or federation-api-s) only.

Data for a request to the get_public_rooms_filtered API endpoint.

Get the list of rooms in this homeserver’s public directory.

Fields

limit: Option<UInt>

Limit for the number of results to return.

since: Option<&'a str>

Pagination token from a previous request.

filter: Filter<'a>

Filter to apply to the results.

room_network: RoomNetwork<'a>

Network to fetch the public room lists from.

Implementations

impl Request<'_>

pub fn new() -> Request<'_>

Creates an empty Request.

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Request<'a>

fn default() -> Request<'a>

Returns the “default value” for a type.

impl<'a> OutgoingRequest for Request<'a>

Available on crate feature client only.

type EndpointError = MatrixError

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

type IncomingResponse = Response

Response type returned when the request is successful.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_into_http_request<T>(
    self,
    base_url: &str,
    access_token: SendAccessToken<'_>,
    considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
    T: Default + BufMut,

Tries to convert this request into an http::Request.