matrix_sdk_base::ruma::api::federation::membership::create_invite::v1

Struct Request

#[non_exhaustive]pub struct Request {
    pub room_id: OwnedRoomId,
    pub event_id: OwnedEventId,
    pub sender: OwnedUserId,
    pub origin: OwnedServerName,
    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
    pub kind: StateEventType,
    pub state_key: OwnedUserId,
    pub content: RoomMemberEventContent,
    pub unsigned: UnsignedEventContent,
}

Expand description

Request type for the create_invite endpoint.

Fields (Non-exhaustive)§

This struct is marked as 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.

§sender: OwnedUserId

The matrix ID of the user who sent the original m.room.third_party_invite.

§origin: OwnedServerName

The name of the inviting homeserver.

§origin_server_ts: MilliSecondsSinceUnixEpoch

A timestamp added by the inviting homeserver.

§kind: StateEventType

The value m.room.member.

§state_key: OwnedUserId

The user ID of the invited member.

§content: RoomMemberEventContent

The content of the event.

§unsigned: UnsignedEventContent

Information included alongside the event that is not signed.

Trait Implementations§

§

impl Clone for Request

§

fn clone(&self) -> Request

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

§

impl Debug for Request

§

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

Formats the value using the given formatter. Read more

§

impl From<RequestInit> for Request

§

fn from(init: RequestInit) -> Request

Creates a new Request from RequestInit.

§

impl OutgoingRequest for Request

§

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: &SupportedVersions, ) -> Result<Request<T>, IntoHttpError>
where T: Default + BufMut,

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

§

fn is_supported(considering_versions: &SupportedVersions) -> bool

Whether the homeserver advertises support for this endpoint. Read more

Auto Trait Implementations§

§

Struct RequestCopy item path

Fields (Non-exhaustive)§

Trait Implementations§

impl Clone for Request

fn clone(&self) -> Request

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

impl Debug for Request

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

impl From<RequestInit> for Request

fn from(init: RequestInit) -> Request

impl OutgoingRequest for Request

const METADATA: Metadata = METADATA

type EndpointError = MatrixError

type IncomingResponse = Response

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

fn is_supported(considering_versions: &SupportedVersions) -> bool

Auto Trait Implementations§

impl Freeze for Request

impl RefUnwindSafe for Request

impl Send for Request

impl Sync for Request

impl Unpin for Request

impl UnwindSafe for Request

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

fn compat_ref(&self) -> Compat<&T>

fn compat_mut(&mut self) -> Compat<&mut T>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, UT> HandleAlloc<UT> for Twhere T: Send + Sync,

fn new_handle(value: Arc<T>) -> Handle

fn clone_handle(handle: Handle) -> Handle

fn consume_handle(handle: Handle) -> Arc<T>

fn get_arc(handle: Handle) -> Arc<Self>

impl<T, W> HasTypeWitness<W> for Twhere W: MakeTypeWitness<Arg = T>, T: ?Sized,

const WITNESS: W = W::MAKE

impl<T> Identity for Twhere T: ?Sized,

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

type Type = T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T> OutgoingRequestAppserviceExt for Twhere T: OutgoingRequest,

fn try_into_http_request_with_user_id<T>( self, base_url: &str, access_token: SendAccessToken<'_>, user_id: &UserId, considering: &SupportedVersions, ) -> Result<Request<T>, IntoHttpError>where T: Default + BufMut,

impl<T> Same for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> AsyncTraitDeps for Twhere T: Debug + SendOutsideWasm + SyncOutsideWasm,

impl<T> ErasedDestructor for Twhere T: 'static,

impl<T> JsonCastable<CanonicalJsonValue> for T

impl<T> JsonCastable<Value> for T

impl<T> MaybeSendSync for T

Struct Request

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

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

impl<T> Identity for T
where T: ?Sized,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<T> OutgoingRequestAppserviceExt for T
where T: OutgoingRequest,

fn try_into_http_request_with_user_id<T>( self, base_url: &str, access_token: SendAccessToken<'_>, user_id: &UserId, considering: &SupportedVersions, ) -> Result<Request<T>, IntoHttpError>
where T: Default + BufMut,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

impl<T> AsyncTraitDeps for T
where T: Debug + SendOutsideWasm + SyncOutsideWasm,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> SendOutsideWasm for T
where T: Send,

impl<T> SyncOutsideWasm for T
where T: Sync,