Struct matrix_sdk::send_queue::RoomSendQueue

source ·
pub struct RoomSendQueue { /* private fields */ }
Expand description

A per-room send queue.

This is cheap to clone.

Implementations§

source§

impl RoomSendQueue

source

pub async fn send_attachment( &self, filename: &str, content_type: Mime, data: Vec<u8>, config: AttachmentConfig, ) -> Result<SendHandle, RoomSendQueueError>

Queues an attachment to be sent to the room, using the send queue.

This returns quickly (without sending or uploading anything), and will push the event to be sent into a queue, handled in the background.

Callers are expected to consume RoomSendQueueUpdate via calling the Self::subscribe() method to get updates about the sending of that event.

By default, if sending failed on the first attempt, it will be retried a few times. If sending failed after those retries, the entire client’s sending queue will be disabled, and it will need to be manually re-enabled by the caller (e.g. after network is back, or when something has been done about the faulty requests).

source§

impl RoomSendQueue

source

pub async fn send_raw( &self, content: Raw<AnyMessageLikeEventContent>, event_type: String, ) -> Result<SendHandle, RoomSendQueueError>

Queues a raw event for sending it to this room.

This immediately returns, and will push the event to be sent into a queue, handled in the background.

Callers are expected to consume RoomSendQueueUpdate via calling the Self::subscribe() method to get updates about the sending of that event.

By default, if sending failed on the first attempt, it will be retried a few times. If sending failed after those retries, the entire client’s sending queue will be disabled, and it will need to be manually re-enabled by the caller (e.g. after network is back, or when something has been done about the faulty requests).

source

pub async fn send( &self, content: AnyMessageLikeEventContent, ) -> Result<SendHandle, RoomSendQueueError>

Queues an event for sending it to this room.

This immediately returns, and will push the event to be sent into a queue, handled in the background.

Callers are expected to consume RoomSendQueueUpdate via calling the Self::subscribe() method to get updates about the sending of that event.

By default, if sending failed on the first attempt, it will be retried a few times. If sending failed after those retries, the entire client’s sending queue will be disabled, and it will need to be manually re-enabled by the caller (e.g. after network is back, or when something has been done about the faulty requests).

source

pub async fn subscribe( &self, ) -> Result<(Vec<LocalEcho>, Receiver<RoomSendQueueUpdate>), RoomSendQueueError>

Returns the current local requests as well as a receiver to listen to the send queue updates, as defined in RoomSendQueueUpdate.

source

pub fn is_enabled(&self) -> bool

Returns whether the room is enabled, at the room level.

source

pub fn set_enabled(&self, enabled: bool)

Set the locally enabled flag for this room queue.

Trait Implementations§

source§

impl Clone for RoomSendQueue

source§

fn clone(&self) -> RoomSendQueue

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 RoomSendQueue

source§

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

Formats the value using the given formatter. 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§

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

🔬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,

§

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§

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§

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> IntoEither for T

source§

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

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

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

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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>,

§

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> Any for T
where T: Any,

source§

impl<T> AsyncTraitDeps for T

source§

impl<T> CloneAny for T
where T: Any + Clone,

source§

impl<T> CloneAnySend for T
where T: Any + Send + Clone,

source§

impl<T> CloneAnySendSync for T
where T: Any + Send + Sync + Clone,

source§

impl<T> CloneAnySync for T
where T: Any + Sync + Clone,

source§

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

source§

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