Trait Progress

Source
pub trait Progress: Future {
    // Required method
    fn progress(
        &self,
    ) -> impl Stream<Item = ProgressUpdate> + Unpin + Send + 'static;
}
Expand description

A trait for futures that can report progress updates.

This trait extends Future to provide a method for accessing a stream of progress updates. The progress updates are emitted as ProgressUpdate items through a Stream.

Required Methods§

Source

fn progress( &self, ) -> impl Stream<Item = ProgressUpdate> + Unpin + Send + 'static

Returns a stream of progress updates for this operation.

The stream will emit ProgressUpdate instances as the operation progresses. The stream should be polled concurrently with the future to receive updates.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§