Skip to main content

UploadEvent

Enum UploadEvent 

Source
pub enum UploadEvent {
    Start {
        total_files: usize,
        total_bytes: u64,
    },
    Progress {
        bytes_completed: u64,
        total_bytes: u64,
        bytes_per_sec: Option<f64>,
        transfer_bytes_completed: u64,
        transfer_bytes: u64,
        transfer_bytes_per_sec: Option<f64>,
        files: Vec<FileProgress>,
    },
    Committing,
    Complete,
}
Expand description

Lifecycle events for a single upload operation. See the module-level docs for the StartProgressCommittingComplete ordering and the silent-gap caveats.

Variants§

§

Start

Upload has begun; totals are known.

Fields

§total_files: usize

Number of files the operation will upload (excludes deletes and other non-add operations in a commit).

§total_bytes: u64

Sum of source-content sizes in bytes, before xet deduplication.

§

Progress

Byte-level progress during the active upload phase, emitted at ~10Hz by the xet upload poll loop.

Two byte-count dimensions are reported because xet performs content-defined deduplication. The bytes_completed / total_bytes pair tracks logical content bytes (use for a “% processed” bar); the transfer_bytes_* triplet tracks post-dedup network bytes actually sent (use for a “network activity” bar). For deduplicated data, transfer_bytestotal_bytes.

files is a snapshot of every xet-tracked file’s state at this event. May be empty for operations that don’t go through xet (small inline files skip Progress entirely).

Fields

§bytes_completed: u64

Logical content bytes processed so far across all files.

§total_bytes: u64

Total logical content bytes for the operation (matches Start.total_bytes).

§bytes_per_sec: Option<f64>

Rate of logical content processing in bytes/sec. None during warm-up.

§transfer_bytes_completed: u64

Post-dedup network bytes actually sent so far.

§transfer_bytes: u64

Total post-dedup network bytes the operation is expected to send.

§transfer_bytes_per_sec: Option<f64>

Rate of network transfer in bytes/sec. None during warm-up.

§files: Vec<FileProgress>

Per-file snapshot of every xet-tracked file in the upload.

§

Committing

Emitted once, immediately before the commit API call. Signals that all byte transfer is done; the call itself is silent until Complete.

§

Complete

Terminal event on success. Not emitted on failure — check the returned Result.

Trait Implementations§

Source§

impl Clone for UploadEvent

Source§

fn clone(&self) -> UploadEvent

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 Debug for UploadEvent

Source§

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

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

impl From<UploadEvent> for ProgressEvent

Source§

fn from(event: UploadEvent) -> Self

Converts to this type from the input type.

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§

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> 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: Sized + 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: Sized + 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<E> ResultError for E
where E: Send + Debug + Sync,

Source§

impl<T> ResultType for T
where T: Send + Clone + Sync + Debug,

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