Struct ruma::api::federation::knock::send_knock::v1::Request

pub struct Request<'a> {
    pub room_id: &'a RoomId,
    pub event_id: &'a EventId,
    pub knock_event: &'a StateEvent<MemberEventContent>,
}

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

Data for a request to the send_knock API endpoint.

Submits a signed knock event to the resident homeserver for it to accept into the room’s graph.

Fields

room_id: &'a RoomId

The room ID that should receive the knock.

event_id: &'a EventId

The event ID for the knock event.

knock_event: &'a StateEvent<MemberEventContent>

The full knock event.

Implementations

impl<'a> Request<'a>

pub fn new(
    room_id: &'a RoomId,
    event_id: &'a EventId,
    knock_event: &'a StateEvent<MemberEventContent>
) -> Request<'a>

Creates a new Request with the given room ID, event ID and knock event.

Trait Implementations

impl<'a> Clone for Request<'a>

pub fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> Outgoing for Request<'a>

type Incoming = IncomingRequest

The ‘Incoming’ variant of Self.

impl<'a> OutgoingRequest for Request<'a>

type EndpointError = MatrixError

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

type IncomingResponse = <Response as Outgoing>::Incoming

Response type returned when the request is successful.

pub const METADATA: Metadata

Metadata about the endpoint.

pub fn try_into_http_request<T>(
    self,
    base_url: &str,
    access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError> where
    T: Default + BufMut, 

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