Skip to main content

GroupProgress

Struct GroupProgress 

Source
pub struct GroupProgress {
    pub total_bytes: AtomicU64,
    pub total_bytes_completed: AtomicU64,
    pub total_transfer_bytes: AtomicU64,
    pub total_transfer_bytes_completed: AtomicU64,
    /* private fields */
}
Expand description

Aggregate progress across all items, with an item registry. Owns the atomic group-level counters and a map of per-item progress.

Fields§

§total_bytes: AtomicU64§total_bytes_completed: AtomicU64§total_transfer_bytes: AtomicU64§total_transfer_bytes_completed: AtomicU64

Implementations§

Source§

impl GroupProgress

Source

pub fn new() -> Arc<Self>

Create a group progress tracker using default speed estimation parameters.

Source

pub fn with_speed_config( half_life: Duration, min_observations: u32, ) -> Arc<Self>

Create a group progress tracker with explicit speed estimation parameters.

Source

pub fn new_item( self: &Arc<Self>, id: UniqueID, name: impl Into<Arc<str>>, ) -> Arc<ItemProgressUpdater>

Create a new tracked item and register it in the items map. Returns an ItemProgressUpdater handle for the caller to report progress.

Source

pub fn new_completion_tracker(self: &Arc<Self>) -> CompletionTracker

Create a new CompletionTracker backed by this group’s progress.

Source

pub fn report(&self) -> GroupProgressReport

Snapshot of aggregate progress. Reads completions first (Acquire), then totals to reduce transient sampling skew.

Speed is estimated via [SpeedTracker], which uses an exponentially-weighted moving average to produce smoothed bytes-per-second rates.

This call updates internal speed-estimation state, so repeated calls are not strictly idempotent. Rate fields remain None until enough speed observations have been collected.

Source

pub fn item_reports(&self) -> HashMap<UniqueID, ItemProgressReport>

Snapshot of all per-item progress.

Source

pub fn item_report(&self, id: UniqueID) -> Option<ItemProgressReport>

Snapshot of one item’s progress.

Source

pub fn assert_complete(&self)

Debug verification that all items are complete.

Trait Implementations§

Source§

impl Debug for GroupProgress

Source§

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

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

impl Default for GroupProgress

Source§

fn default() -> Self

Returns the “default value” for a type. 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> DropFlavorWrapper<T> for T

Source§

type Flavor = MayDrop

The DropFlavor that wraps T into Self
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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<E> ResultError for E
where E: Send + Debug + Sync,