Struct ruma_client_api::knock::knock_room::v3::Request
source · [−]pub struct Request<'a> {
pub room_id_or_alias: &'a RoomOrAliasId,
pub reason: Option<&'a str>,
pub server_name: &'a [OwnedServerName],
}
Available on crate features
client
or server
only.Expand description
Data for a request to the knock_room
API endpoint.
Knock on a room.
Fields
room_id_or_alias: &'a RoomOrAliasId
The room the user should knock on.
reason: Option<&'a str>
The reason for joining a room.
server_name: &'a [OwnedServerName]
The servers to attempt to knock on the room through.
One of the servers must be participating in the room.
Implementations
sourceimpl<'a> Request<'a>
impl<'a> Request<'a>
sourcepub fn new(room_id_or_alias: &'a RoomOrAliasId) -> Self
pub fn new(room_id_or_alias: &'a RoomOrAliasId) -> Self
Creates a new Request
with the given room ID or alias.
Trait Implementations
sourceimpl<'a> OutgoingRequest for Request<'a>
Available on crate feature client
only.
impl<'a> OutgoingRequest for Request<'a>
Available on crate feature
client
only.type EndpointError = MatrixError
type EndpointError = MatrixError
A type capturing the expected error conditions the server can return.
type IncomingResponse = Response
type IncomingResponse = Response
Response type returned when the request is successful.
sourcefn 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<'a> RefUnwindSafe for Request<'a>
impl<'a> Send for Request<'a>
impl<'a> Sync for Request<'a>
impl<'a> Unpin for Request<'a>
impl<'a> UnwindSafe for Request<'a>
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
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
sourcefn 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>where
T: Default + BufMut,
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>where
T: Default + BufMut,
Tries to convert this request into an
http::Request
and appends a virtual user_id
to
assert Appservice identity. Read more