Struct ruma_federation_api::space::get_hierarchy::v1::Response

pub struct Response {
    pub children: Vec<SpaceHierarchyChildSummary>,
    pub inaccessible_children: Vec<OwnedRoomId>,
    pub room: SpaceHierarchyParentSummary,
}

Response type for the hierarchy endpoint.

Fields

children: Vec<SpaceHierarchyChildSummary>

A summary of the space’s children.

Rooms which the requesting server cannot peek/join will be excluded.

inaccessible_children: Vec<OwnedRoomId>

The list of room IDs the requesting server doesn’t have a viable way to peek/join.

Rooms which the responding server cannot provide details on will be outright excluded from the response instead.

room: SpaceHierarchyParentSummary

A summary of the requested room.

Implementations

impl Response

pub fn new(room_summary: SpaceHierarchyParentSummary) -> Self

Creates a new Response with the given room summary.

Trait Implementations

impl Clone for Response

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

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

Formats the value using the given formatter.

impl IncomingResponse for Response

Available on crate feature client only.

type EndpointError = MatrixError

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

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

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

impl OutgoingResponse for Response

Available on crate feature server only.

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

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