Struct ruma_client_api::r0::knock::knock_room::Request[][src]

pub struct Request<'a> {
    pub room_id_or_alias: RoomIdOrAliasId,
    pub reason: Option<&'a str>,
    pub server_name: &'a [ServerNameBox],
}
This is supported on crate feature unstable-pre-spec only.
Expand description

Data for a request to the knock_room API endpoint.

Knock on a room.

Fields

room_id_or_alias: RoomIdOrAliasId

The room the user should knock on.

reason: Option<&'a str>

The reason for joining a room.

server_name: &'a [ServerNameBox]

The servers to attempt to knock on the room through.

One of the servers must be participating in the room.

Implementations

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

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

The ‘Incoming’ variant of Self.

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

Response type returned when the request is successful.

Metadata about the endpoint.

Tries to convert this request into an http::Request. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

Tries to convert this request into an http::Request and appends a virtual user_id to assert Appservice identity. Read more

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more