Struct ruma_client_api::knock::knock_room::v3::Request

pub struct Request {
    pub room_id_or_alias: OwnedRoomOrAliasId,
    pub reason: Option<String>,
    pub server_name: Vec<OwnedServerName>,
}

Available on crate features client or server only.

Request type for the knock_room endpoint.

Fields

room_id_or_alias: OwnedRoomOrAliasId

The room the user should knock on.

reason: Option<String>

The reason for joining a room.

server_name: Vec<OwnedServerName>

The servers to attempt to knock on the room through.

One of the servers must be participating in the room.

Implementations

impl Request

pub fn new(room_id_or_alias: OwnedRoomOrAliasId) -> Self

Creates a new Request with the given room ID or alias.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Request

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl IncomingRequest for Request

Available on crate feature server only.

type EndpointError = Error

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S] ) -> Result<Self, FromHttpRequestError>where B: AsRef<[u8]>, S: AsRef<str>,

Tries to turn the given http::Request into this request type, together with the corresponding path arguments.

impl OutgoingRequest for Request

Available on crate feature client only.

type EndpointError = Error

A type capturing the expected error conditions the server can return.

type IncomingResponse = Response

Response type returned when the request is successful.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.