Struct Request

#[non_exhaustive]
pub struct Request {
    pub room_id: OwnedRoomId,
    pub event_id: OwnedEventId,
    pub room_version: RoomVersionId,
    pub event: Box<RawValue>,
    pub invite_room_state: Vec<Raw<AnyStrippedStateEvent>>,
    pub via: Option<Vec<OwnedServerName>>,
}

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

Request type for the create_invite 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: 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>

The invite event which needs to be signed.

invite_room_state: Vec<Raw<AnyStrippedStateEvent>>

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

via: Option<Vec<OwnedServerName>>

Available on crate feature unstable-msc4125 only.

An optional list of servers the invited homeserver should attempt to join or leave via, according to MSC4125.

If present, it must not be empty.

Implementations

impl Request

pub fn new( room_id: OwnedRoomId, event_id: OwnedEventId, room_version: RoomVersionId, event: Box<RawValue>, invite_room_state: Vec<Raw<AnyStrippedStateEvent>>, ) -> Request

Creates a new Request with the given room ID, event ID, room version, event and invite room state.

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<(), Error>

Formats the value using the given formatter.

impl IncomingRequest for Request

Available on crate feature server only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

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.

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

impl OutgoingRequest for Request

Available on crate feature client only.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = MatrixError

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

type IncomingResponse = Response

Response type returned when the request is successful.

fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut,

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