Skip to main content

OutgoingRequestKind

Enum OutgoingRequestKind 

Source
pub enum OutgoingRequestKind {
Show 29 variants Sync, KeysUpload, KeysQuery, KeysClaim, KeysChanges, SendToDevice, SigningKeysUpload, SignaturesUpload, RoomSend, RoomRedact, RoomState, RoomMessages, RoomMembers, CreateRoom, JoinRoom, LeaveRoom, Invite, Kick, SetState, Typing, Receipt, ReadMarkers, AccountData, RoomAccountData, Profile, UserDirectorySearch, PublicRooms, BackupVersion, BackupKeys,
}
Expand description

What kind of Matrix Client-Server API call an OutgoingRequest is — a plain tag the core uses to know how to interpret the matching HttpResponseDescriptor (e.g. “this one’s body is a SyncResponse”). The actual path/query/body are already baked into the OutgoingRequest itself; this enum carries no duplicate parameters.

Variants§

§

Sync

GET /sync — long-poll for new events, device-list changes, and one-time-key counts.

§

KeysUpload

POST /keys/upload — publish device identity keys and one-time keys.

§

KeysQuery

POST /keys/query — fetch other users’ device keys.

§

KeysClaim

POST /keys/claim — claim one-time keys to start new Olm sessions.

§

KeysChanges

GET /keys/changes — list users whose device lists changed in a sync range.

§

SendToDevice

PUT /sendToDevice/{eventType}/{txnId} — send one or more to-device events.

§

SigningKeysUpload

POST /keys/device_signing/upload — publish cross-signing keys.

§

SignaturesUpload

POST /keys/signatures/upload — publish cross-signing signatures.

§

RoomSend

PUT /rooms/{roomId}/send/{eventType}/{txnId} — send a timeline event.

§

RoomRedact

PUT /rooms/{roomId}/redact/{eventId}/{txnId} — redact an event.

§

RoomState

PUT /rooms/{roomId}/state/{eventType}/{stateKey} — set one piece of room state.

§

RoomMessages

GET /rooms/{roomId}/messages — paginate a room’s timeline.

§

RoomMembers

GET /rooms/{roomId}/members — list a room’s members.

§

CreateRoom

POST /createRoom — create a room.

§

JoinRoom

POST /rooms/{roomId}/join — join a room by id.

§

LeaveRoom

POST /rooms/{roomId}/leave — leave a room.

§

Invite

POST /rooms/{roomId}/invite — invite a user to a room.

§

Kick

POST /rooms/{roomId}/kick — remove a user from a room.

§

SetState

PUT /rooms/{roomId}/state/{eventType}/{stateKey} — set a room state event.

§

Typing

PUT /rooms/{roomId}/typing/{userId} — set/clear a typing indicator.

§

Receipt

POST /rooms/{roomId}/receipt/{receiptType}/{eventId} — send a read receipt.

§

ReadMarkers

POST /rooms/{roomId}/read_markers — set the fully-read marker.

§

AccountData

PUT /user/{userId}/account_data/{type} — set global account data.

§

RoomAccountData

PUT /user/{userId}/rooms/{roomId}/account_data/{type} — set room-scoped account data.

§

Profile

GET /profile/{userId} — fetch a user’s profile.

§

UserDirectorySearch

POST /user_directory/search — search the user directory.

§

PublicRooms

POST /publicRooms — search the public-room directory.

§

BackupVersion

GET /room_keys/version — fetch the current key backup version.

§

BackupKeys

GET /room_keys/keys/{roomId}/{sessionId} — fetch one backed-up Megolm session.

Trait Implementations§

Source§

impl Clone for OutgoingRequestKind

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for OutgoingRequestKind

Source§

impl Debug for OutgoingRequestKind

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for OutgoingRequestKind

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for OutgoingRequestKind

Source§

impl Hash for OutgoingRequestKind

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for OutgoingRequestKind

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for OutgoingRequestKind

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for OutgoingRequestKind

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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