Struct ruma::api::federation::knock::create_knock_event_template::v1::Request
source · pub struct Request {
pub room_id: OwnedRoomId,
pub user_id: OwnedUserId,
pub ver: Vec<RoomVersionId>,
}
Available on crate feature
api
and (crate features federation-api-c
or federation-api-s
) only.Expand description
Request type for the create_knock_event_template
endpoint.
Fields§
§room_id: OwnedRoomId
The room ID that should receive the knock.
user_id: OwnedUserId
The user ID the knock event will be for.
ver: Vec<RoomVersionId>
The room versions the sending has support for.
Defaults to vec![RoomVersionId::V1]
.
Implementations§
source§impl Request
impl Request
sourcepub fn new(room_id: OwnedRoomId, user_id: OwnedUserId) -> Request
pub fn new(room_id: OwnedRoomId, user_id: OwnedUserId) -> Request
Creates a Request
with the given room ID and user ID.
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 = MatrixError
type EndpointError = MatrixError
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 = MatrixError
type EndpointError = MatrixError
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>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request<T>( 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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)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> 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 moresource§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.