Struct Request
#[non_exhaustive]pub struct Request {
pub room_id: OwnedRoomId,
pub event_id: OwnedEventId,
pub pdu: Box<RawValue>,
}
๐Deprecated: Since Matrix Server-Server API r0.1.4. Use the v2 endpoint instead.
Expand description
Request type for the create_join_event
endpoint.
Fields (Non-exhaustive)ยง
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.room_id: OwnedRoomId
๐Deprecated: Since Matrix Server-Server API r0.1.4. Use the v2 endpoint instead.
The room ID that is about to be joined.
Do not use this. Instead, use the room_id
field inside the PDU.
event_id: OwnedEventId
๐Deprecated: Since Matrix Server-Server API r0.1.4. Use the v2 endpoint instead.
The event ID for the join event.
pdu: Box<RawValue>
๐Deprecated: Since Matrix Server-Server API r0.1.4. Use the v2 endpoint instead.
The PDU.
Implementationsยง
ยงimpl Request
impl Request
pub fn new(
room_id: OwnedRoomId,
event_id: OwnedEventId,
pdu: Box<RawValue>,
) -> Request
pub fn new( room_id: OwnedRoomId, event_id: OwnedEventId, pdu: Box<RawValue>, ) -> Request
Creates a new Request
from the given room ID, event ID and PDU.
Trait Implementationsยง
ยงimpl OutgoingRequest for Request
impl OutgoingRequest for Request
ยง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.
ยงfn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering: &SupportedVersions,
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering: &SupportedVersions, ) -> Result<Request<T>, IntoHttpError>
Tries to convert this request into an
http::Request
. Read moreยงfn is_supported(considering_versions: &SupportedVersions) -> bool
fn is_supported(considering_versions: &SupportedVersions) -> bool
Whether the homeserver advertises support for this endpoint. Read more
Auto 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,
ยงimpl<T> CompatExt for T
impl<T> CompatExt for T
Sourceยงimpl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
Sourceยงfn consume_handle(handle: Handle) -> Arc<T>
fn consume_handle(handle: Handle) -> Arc<T>
Consume a handle, getting back the initial
Arc<>
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,
ยงimpl<T> Instrument for T
impl<T> Instrument for T
ยงfn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
ยงfn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Sourceยงimpl<T> IntoEither for T
impl<T> IntoEither for T
Sourceยงfn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSourceยงfn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreยงimpl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
ยงfn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: &UserId,
considering: &SupportedVersions,
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request_with_user_id<T>( self, base_url: &str, access_token: SendAccessToken<'_>, user_id: &UserId, considering: &SupportedVersions, ) -> Result<Request<T>, IntoHttpError>
Tries to convert this request into an
http::Request
and appends a virtual user_id
to
assert Appservice identity.