Struct ruma::api::federation::membership::create_invite::v2::IncomingRequest

pub struct IncomingRequest {
    pub room_id: OwnedRoomId,
    pub event_id: OwnedEventId,
    pub room_version: RoomVersionId,
    pub event: Box<RawValue, Global>,
    pub invite_room_state: Vec<Raw<AnyStrippedStateEvent>, Global>,
}

Available on crate feature api and (crate features federation-api-c or federation-api-s) only.

‘Incoming’ variant of Request.

Fields

room_id: OwnedRoomId

The room ID that the user is being invited to.

event_id: OwnedEventId

The event ID for the invite event, generated by the inviting server.

room_version: RoomVersionId

The version of the room where the user is being invited to.

event: Box<RawValue, Global>

The invite event which needs to be signed.

invite_room_state: Vec<Raw<AnyStrippedStateEvent>, Global>

An optional list of simplified events to help the receiver of the invite identify the room.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

Available on crate feature server only.

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.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>(
    request: Request<B>,
    path_args: &[S]
) -> Result<IncomingRequest, 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.