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

#[non_exhaustive]
pub struct Request {
    pub room_id_or_alias: OwnedRoomOrAliasId,
    pub reason: Option<String>,
    pub via: Vec<OwnedServerName>,
}

Request type for the knock_room endpoint.

Fields (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_or_alias: OwnedRoomOrAliasId

The room the user should knock on.

reason: Option<String>

The reason for joining a room.

via: Vec<OwnedServerName>

The servers to attempt to knock on the room through.

One of the servers must be participating in the room.

When serializing, this field is mapped to both server_name and via with identical values.

When deserializing, the value is read from via if it’s not missing or empty and server_name otherwise.

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 OutgoingRequest for Request

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.