Enum RoomSendQueueUpdate

pub enum RoomSendQueueUpdate {
    NewLocalEvent(LocalEcho),
    CancelledLocalEvent {
        transaction_id: OwnedTransactionId,
    },
    ReplacedLocalEvent {
        transaction_id: OwnedTransactionId,
        new_content: SerializableEventContent,
    },
    SendError {
        transaction_id: OwnedTransactionId,
        error: Arc<Error>,
        is_recoverable: bool,
    },
    RetryEvent {
        transaction_id: OwnedTransactionId,
    },
    SentEvent {
        transaction_id: OwnedTransactionId,
        event_id: OwnedEventId,
    },
    MediaUpload {
        related_to: OwnedTransactionId,
        file: Option<MediaSource>,
        index: u64,
        progress: AbstractProgress,
    },
}

An update to a room send queue, observable with RoomSendQueue::subscribe.

Variants

NewLocalEvent(LocalEcho)

A new local event is being sent.

There’s been a user query to create this event. It is being sent to the server.

CancelledLocalEvent

A local event that hadn’t been sent to the server yet has been cancelled before sending.

Fields

transaction_id: OwnedTransactionId

Transaction id used to identify this event.

ReplacedLocalEvent

A local event’s content has been replaced with something else.

Fields

transaction_id: OwnedTransactionId

Transaction id used to identify this event.

new_content: SerializableEventContent

The new content replacing the previous one.

SendError

An error happened when an event was being sent.

The event has not been removed from the queue. All the send queues will be disabled after this happens, and must be manually re-enabled.

Fields

transaction_id: OwnedTransactionId

Transaction id used to identify this event.

error: Arc<Error>

Error received while sending the event.

is_recoverable: bool

Whether the error is considered recoverable or not.

An error that’s recoverable will disable the room’s send queue, while an unrecoverable error will be parked, until the user decides to cancel sending it.

RetryEvent

The event has been unwedged and sending is now being retried.

Fields

transaction_id: OwnedTransactionId

Transaction id used to identify this event.

SentEvent

The event has been sent to the server, and the query returned successfully.

Fields

transaction_id: OwnedTransactionId

Transaction id used to identify this event.

event_id: OwnedEventId

Received event id from the send response.

MediaUpload

A media upload (consisting of a file and possibly a thumbnail) has made progress.

Fields

related_to: OwnedTransactionId

The media event this uploaded media relates to.

file: Option<MediaSource>

The final media source for the file if it has finished uploading.

index: u64

The index of the media within the transaction. A file and its thumbnail share the same index. Will always be 0 for non-gallery media uploads.

progress: AbstractProgress

The combined upload progress across the file and, if existing, its thumbnail. For gallery uploads, the progress is reported per indexed gallery item.

Trait Implementations

impl Clone for RoomSendQueueUpdate

fn clone(&self) -> RoomSendQueueUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoomSendQueueUpdate

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

Formats the value using the given formatter.