pub struct Painter { /* private fields */ }Expand description
The bar painter.
Implementations§
Source§impl Painter
impl Painter
Sourcepub fn from_draw_target(target: Option<ProgressDrawTarget>) -> Self
pub fn from_draw_target(target: Option<ProgressDrawTarget>) -> Self
Build a painter over target. None builds the strict no-op painter:
there is no bar to write through, so Painter::paint cannot reach a
console.
Sourcepub fn console() -> Self
pub fn console() -> Self
The console painter: the bar when stderr is a terminal, otherwise the one-line-per-chunk record on stdout when stdout itself is redirected.
Sourcepub const fn is_active(&self) -> bool
pub const fn is_active(&self) -> bool
Whether any progress surface is attached (a terminal bar, or a redirected-stdout record).
Sourcepub fn paint(&self, percent: u64, message: &str)
pub fn paint(&self, percent: u64, message: &str)
Paint the bar at percent with message. A no-op when no draw target
is attached.
Sourcepub fn chunk(&self, percent: u64, cursor: Option<u64>, message: Option<&str>)
pub fn chunk(&self, percent: u64, cursor: Option<u64>, message: Option<&str>)
Report one committed chunk: paint the bar when a terminal is attached, otherwise append one progress record line to the redirected stdout.
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for Painter
impl Forget for Painter
impl Move for Painter
impl RefUnwindSafe for Painter
impl Send for Painter
impl Sync for Painter
impl Unpin for Painter
impl UnsafeUnpin for Painter
impl UnwindSafe for Painter
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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