BatchUploadProgress class final

How far a batch upload has got, both in attachments and in bytes.

The counts and the bytes answer different questions, so both are kept: "uploading 3 of 7" and "5 uploaded · 1 failed · 1 remaining" come from the counts, while a progress bar comes from fraction.

'${progress.finished} of ${progress.total}'

// `null` until every attachment's length is known, and for a batch with
// one that could never be read.
if (progress.fraction case final fraction?) drawBar(fraction);

Constructors

BatchUploadProgress({required int total, required int queued, required int preparing, required int uploading, required int succeeded, required int failed, required int cancelled, required int sentBytes, required int? totalBytes})
Creates a BatchUploadProgress.
const

Properties

cancelled → int
How many attachments were called off.
final
failed → int
How many attachments failed.
final
finished → int
How many attachments have settled.
no setter
fraction → double?
The sent fraction, between 0.0 and 1.0, or null while totalBytes is still unknown.
no setter
hashCode → int
The hash code for this object.
no setterinherited
preparing → int
How many attachments are being read.
final
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setter
queued → int
How many attachments are waiting for a turn.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sentBytes → int
The number of bytes sent so far, across the batch.
final
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
succeeded → int
How many attachments made it.
final
total → int
The number of attachments in the batch.
final
totalBytes → int?
The number of attachment bytes the batch has to send.
final
uploading → int
How many attachments are on their way.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited