Struct ruma_client_api::space::get_hierarchy::v1::IncomingRequest
source · [−]pub struct IncomingRequest {
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
‘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
sourceimpl Debug for IncomingRequest
impl Debug for IncomingRequest
sourceimpl IncomingRequest for IncomingRequest
Available on crate feature server
only.
impl IncomingRequest for IncomingRequest
Available on crate feature
server
only.type EndpointError = Error
type EndpointError = Error
A type capturing the error conditions that can be returned in the response.
type OutgoingResponse = Response
type OutgoingResponse = Response
Response type to return when the request is successful.
Auto Trait Implementations
impl RefUnwindSafe for IncomingRequest
impl Send for IncomingRequest
impl Sync for IncomingRequest
impl Unpin for IncomingRequest
impl UnwindSafe for IncomingRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more