Struct ruma::api::federation::space::get_hierarchy::v1::Request

pub struct Request<'a> {
    pub room_id: &'a RoomId,
    pub suggested_only: bool,
}

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

Data for a request to the hierarchy API endpoint.

Get the space tree in a depth-first manner to locate child rooms of a given space.

Fields

room_id: &'a RoomId

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<'a> Request<'a>

pub fn new(room_id: &'a RoomId) -> Request<'a>

Creates a Request with the given room ID.

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