Struct Request 

#[non_exhaustive]
pub struct Request {
    pub room_id: OwnedRoomId,
    pub suggested_only: bool,
}

Request type for the hierarchy 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.

room_id: OwnedRoomId

The room ID of the space to get a hierarchy for.

suggested_only: bool

Whether or not the server should only consider suggested rooms.

Suggested rooms are annotated in their m.space.child event contents.

Implementations

impl Request

pub fn new(room_id: OwnedRoomId) -> Request

Creates a Request with the given room ID.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl From<Request> for Request

fn from(value: Request) -> Request

Converts to this type from the input type.

impl From<Request> for Request

fn from(value: Request) -> Request

Converts to this type from the input type.

impl Metadata for Request

const METHOD: Method = super::v1::Request::METHOD

The HTTP method used by this endpoint.

const RATE_LIMITED: bool = false

Whether or not this endpoint is rate limited by the server.

const PATH_BUILDER: <Request as Metadata>::PathBuilder

All info pertaining to an endpoint’s path.

type Authentication = <Request as Metadata>::Authentication

What authentication scheme the server uses for this endpoint.

type PathBuilder = <Request as Metadata>::PathBuilder

The type used to build an endpoint’s path.

fn empty_request_body<B>() -> B

where B: Default + BufMut,

Returns an empty request body for this Matrix request.

fn make_endpoint_url( path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>, base_url: &str, path_args: &[&dyn Display], query_string: &str, ) -> Result<String, IntoHttpError>

Generate the endpoint URL for this endpoint.

impl OutgoingRequest for Request

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.

fn try_into_http_request<T>( self, base_url: &str, authentication_input: <<Request as Metadata>::Authentication as AuthScheme>::Input<'_>, path_builder_input: <<Request as Metadata>::PathBuilder as PathBuilder>::Input<'_>, ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut + AsRef<[u8]>,

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