Struct Request

#[non_exhaustive]
pub struct Request {
    pub room_id: OwnedRoomId,
    pub event_id: OwnedEventId,
    pub pdu: Box<RawValue>,
    pub omit_members: bool,
}

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

Request type for the create_join_event 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 is about to be joined.

Do not use this. Instead, use the room_id field inside the PDU.

event_id: OwnedEventId

The event ID for the join event.

pdu: Box<RawValue>

The PDU.

omit_members: bool

Indicates whether the calling server can accept a reduced response.

If true, membership events are omitted from state and redundant events are omitted from auth_chain in the response.

If the room to be joined has no m.room.name nor m.room.canonical_alias events in its current state, the resident server should determine the room members who would be included in the m.heroes property of the room summary as defined in the Client-Server /sync response. The resident server should include these members’ membership events in the response state field, and include the auth chains for these membership events in the response auth_chain field.

Implementations

impl Request

pub fn new( room_id: OwnedRoomId, event_id: OwnedEventId, pdu: Box<RawValue>, ) -> Request

Creates a new Request from the given room ID, event ID and PDU.

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.