pub struct ProgressHandle<'a> { /* private fields */ }Expand description
Ergonomic scoped handle: binds a ProgressToken to a ProgressSink
so tool code can emit without repeating the token argument.
Construct one at the top of a long-running tool’s execute_with_progress
and call ProgressHandle::update as work proceeds.
Implementations§
Source§impl<'a> ProgressHandle<'a>
impl<'a> ProgressHandle<'a>
Sourcepub fn new(sink: &'a dyn ProgressSink, total: Option<u64>) -> Self
pub fn new(sink: &'a dyn ProgressSink, total: Option<u64>) -> Self
Create a handle for a new operation on sink with an optional known total.
Sourcepub fn with_token(
sink: &'a dyn ProgressSink,
token: ProgressToken,
total: Option<u64>,
) -> Self
pub fn with_token( sink: &'a dyn ProgressSink, token: ProgressToken, total: Option<u64>, ) -> Self
Create a handle reusing an existing token (e.g. one supplied by the caller).
Sourcepub fn token(&self) -> ProgressToken
pub fn token(&self) -> ProgressToken
Token backing this handle.
Auto Trait Implementations§
impl<'a> Freeze for ProgressHandle<'a>
impl<'a> !RefUnwindSafe for ProgressHandle<'a>
impl<'a> Send for ProgressHandle<'a>
impl<'a> Sync for ProgressHandle<'a>
impl<'a> Unpin for ProgressHandle<'a>
impl<'a> UnsafeUnpin for ProgressHandle<'a>
impl<'a> !UnwindSafe for ProgressHandle<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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