Struct ruma::api::client::r0::knock::knock_room::IncomingRequest

pub struct IncomingRequest {
    pub room_id_or_alias: RoomIdOrAliasId,
    pub reason: Option<String>,
    pub server_name: Vec<Box<ServerName, Global>, Global>,
}

This is supported on crate feature api and (crate features client-api or client-api-c or client-api-s) only.

‘Incoming’ variant of Request.

Fields

room_id_or_alias: RoomIdOrAliasId

The room the user should knock on.

reason: Option<String>

The reason for joining a room.

server_name: Vec<Box<ServerName, Global>, Global>

The servers to attempt to knock on the room through.

One of the servers must be participating in the room.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

type EndpointError = MatrixError

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.

pub const METADATA: Metadata

Metadata about the endpoint.

pub fn try_from_http_request<T>(
    request: Request<T>
) -> Result<IncomingRequest, FromHttpRequestError> where
    T: AsRef<[u8]>, 

Tries to turn the given http::Request into this request type.