Struct ruma_client_api::space::get_hierarchy::v1::IncomingRequest

pub struct IncomingRequest {
    pub room_id: OwnedRoomId,
    pub from: Option<String>,
    pub limit: Option<UInt>,
    pub max_depth: Option<UInt>,
    pub suggested_only: bool,
}

‘Incoming’ variant of Request.

Fields

room_id: OwnedRoomId

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

from: Option<String>

A pagination token from a previous result.

If specified, max_depth and suggested_only cannot be changed from the first request.

limit: Option<UInt>

The maximum number of rooms to include per response.

max_depth: Option<UInt>

How far to go into the space.

When reached, no further child rooms will be returned.

suggested_only: bool

Whether or not the server should only consider suggested rooms.

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

Defaults to false.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

Available on crate feature server only.

type EndpointError = Error

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>(
    request: Request<B>,
    path_args: &[S]
) -> Result<Self, FromHttpRequestError> where
    B: AsRef<[u8]>,
    S: AsRef<str>, 

Tries to turn the given http::Request into this request type, together with the corresponding path arguments.