Struct ruma::api::client::r0::membership::join_room_by_id_or_alias::Request [−][src]
pub struct Request<'a> {
pub room_id_or_alias: &'a RoomIdOrAliasId,
pub server_name: &'a [Box<ServerName, Global>],
pub third_party_signed: Option<ThirdPartySigned<'a>>,
}
api
and (crate features client-api
or client-api-c
or client-api-s
) only.Expand description
Data for a request to the join_room_by_id_or_alias
API endpoint.
Join a room using its ID or one of its aliases.
Fields
room_id_or_alias: &'a RoomIdOrAliasId
The room where the user should be invited.
server_name: &'a [Box<ServerName, Global>]
The servers to attempt to join the room through. One of the servers must be participating in the room.
third_party_signed: Option<ThirdPartySigned<'a>>
The signature of a m.third_party_invite
token to prove that this user owns a third
party identity which has been invited to the room.
Implementations
Creates a new Request
with the given room ID or alias ID.
Trait Implementations
type Incoming = IncomingRequest
type Incoming = IncomingRequest
The ‘Incoming’ variant of Self
.
type EndpointError = Error
type EndpointError = Error
A type capturing the expected error conditions the server can return.
type IncomingResponse = <Response as Outgoing>::Incoming
type IncomingResponse = <Response as Outgoing>::Incoming
Response type returned when the request is successful.
pub fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError> where
T: Default + BufMut,
pub fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError> where
T: Default + BufMut,
Tries to convert this request into an http::Request
. Read more
Auto Trait Implementations
impl<'a> RefUnwindSafe for Request<'a>
impl<'a> UnwindSafe for Request<'a>
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: UserId
) -> 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
) -> 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
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more