pub struct Request {
pub room_id: OwnedRoomId,
pub from: Option<String>,
pub limit: Option<UInt>,
pub max_depth: Option<UInt>,
pub suggested_only: bool,
}
Available on crate features
client
or server
only.Expand description
Request type for the hierarchy
endpoint.
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
.
Implementations§
Trait Implementations§
Source§impl IncomingRequest for Request
Available on crate feature server
only.
impl IncomingRequest for Request
Available on crate feature
server
only.Source§type EndpointError = Error
type EndpointError = Error
A type capturing the error conditions that can be returned in the response.
Source§type OutgoingResponse = Response
type OutgoingResponse = Response
Response type to return when the request is successful.
Source§impl OutgoingRequest for Request
Available on crate feature client
only.
impl OutgoingRequest for Request
Available on crate feature
client
only.Source§type EndpointError = Error
type EndpointError = Error
A type capturing the expected error conditions the server can return.
Source§type IncomingResponse = Response
type IncomingResponse = Response
Response type returned when the request is successful.
Source§fn try_into_http_request<T: Default + BufMut>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request<T: Default + BufMut>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>
Tries to convert this request into an
http::Request
. Read moreAuto Trait Implementations§
impl Freeze for Request
impl RefUnwindSafe for Request
impl Send for Request
impl Sync for Request
impl Unpin for Request
impl UnwindSafe for Request
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
Source§fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: &UserId,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request_with_user_id<T>( self, base_url: &str, access_token: SendAccessToken<'_>, user_id: &UserId, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>
Tries to convert this request into an
http::Request
and appends a virtual user_id
to
assert Appservice identity.