ruma::api::federation::membership::create_leave_event::v1

Struct Request

Source
#[non_exhaustive]
pub struct Request { pub room_id: OwnedRoomId, pub event_id: OwnedEventId, pub pdu: Box<RawValue>, }
๐Ÿ‘ŽDeprecated: Since Matrix Server-Server API r0.1.4. Use the v2 endpoint instead.
Available on crate feature api and (crate features federation-api-c or federation-api-s) only.
Expand description

Request type for the create_leave_event 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
๐Ÿ‘ŽDeprecated: Since Matrix Server-Server API r0.1.4. Use the v2 endpoint instead.

The room ID that is about to be left.

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

ยงevent_id: OwnedEventId
๐Ÿ‘ŽDeprecated: Since Matrix Server-Server API r0.1.4. Use the v2 endpoint instead.

The event ID for the leave event.

ยงpdu: Box<RawValue>
๐Ÿ‘ŽDeprecated: Since Matrix Server-Server API r0.1.4. Use the v2 endpoint instead.

The PDU.

Implementationsยง

Sourceยง

impl Request

Source

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ยง

Sourceยง

impl Clone for Request

Sourceยง

fn clone(&self) -> Request

Returns a copy of the value. Read more
1.0.0 ยท Sourceยง

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

Performs copy-assignment from source. Read more
Sourceยง

impl Debug for Request

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl IncomingRequest for Request

Available on crate feature server only.
Sourceยง

const METADATA: Metadata = METADATA

Metadata about the endpoint.
Sourceยง

type EndpointError = MatrixError

A type capturing the error conditions that can be returned in the response.
Sourceยง

type OutgoingResponse = Response

Response type to return when the request is successful.
Sourceยง

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. Read more
Sourceยง

impl OutgoingRequest for Request

Available on crate feature client only.
Sourceยง

const METADATA: Metadata = METADATA

Metadata about the endpoint.
Sourceยง

type EndpointError = MatrixError

A type capturing the expected error conditions the server can return.
Sourceยง

type IncomingResponse = Response

Response type returned when the request is successful.
Sourceยง

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. Read more

Auto Trait Implementationsยง

Blanket Implementationsยง

Sourceยง

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

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Sourceยง

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

Sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Sourceยง

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

Sourceยง

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

Mutably borrows from an owned value. Read more
Sourceยง

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

Sourceยง

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

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

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

Sourceยง

const WITNESS: W = W::MAKE

A constant of the type witness
Sourceยง

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

Sourceยง

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

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Sourceยง

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Sourceยง

impl<T> Instrument for T

Sourceยง

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Sourceยง

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Sourceยง

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

Sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Sourceยง

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

Sourceยง

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

Tries to convert this request into an http::Request and appends a virtual user_id to assert Appservice identity.
Sourceยง

impl<T> Same for T

Sourceยง

type Output = T

Should always be Self
Sourceยง

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

Sourceยง

type Owned = T

The resulting type after obtaining ownership.
Sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Sourceยง

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

Uses borrowed data to replace owned data, usually by cloning. Read more
Sourceยง

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

Sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
Sourceยง

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

Performs the conversion.
Sourceยง

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

Sourceยง

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

The type returned in the event of a conversion error.
Sourceยง

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

Performs the conversion.
Sourceยง

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

Sourceยง

fn vzip(self) -> V

Sourceยง

impl<T> WithSubscriber for T

Sourceยง

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

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

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

Sourceยง

impl<T> MaybeSendSync for T