Struct Progress

Source
pub struct Progress<W> { /* private fields */ }

Implementations§

Source§

impl<W: Write> Progress<W>

Source

pub fn new(inner: W, len: u64) -> Self

Examples found in repository?
examples/basic.rs (line 11)
7fn main() {
8    let stdout = io::stdout();
9    let lock = stdout.lock();
10
11    let mut progress = Progress::new(lock, 100);
12
13    for i in 0..=100 {
14        let _ = writeln!(
15            progress,
16            "{n} small step for man, {n} giant leap for mankind",
17            n = i
18        );
19
20        progress.pos(i);
21
22        let _ = progress.render();
23        let _ = progress.render();
24
25        thread::sleep(Duration::from_millis(10));
26    }
27
28    let mut lock = progress.finish();
29
30    let _ = writeln!(lock);
31}
Source

pub fn pos(&mut self, pos: u64)

Examples found in repository?
examples/basic.rs (line 20)
7fn main() {
8    let stdout = io::stdout();
9    let lock = stdout.lock();
10
11    let mut progress = Progress::new(lock, 100);
12
13    for i in 0..=100 {
14        let _ = writeln!(
15            progress,
16            "{n} small step for man, {n} giant leap for mankind",
17            n = i
18        );
19
20        progress.pos(i);
21
22        let _ = progress.render();
23        let _ = progress.render();
24
25        thread::sleep(Duration::from_millis(10));
26    }
27
28    let mut lock = progress.finish();
29
30    let _ = writeln!(lock);
31}
Source

pub fn render(&mut self) -> Result<()>

Examples found in repository?
examples/basic.rs (line 22)
7fn main() {
8    let stdout = io::stdout();
9    let lock = stdout.lock();
10
11    let mut progress = Progress::new(lock, 100);
12
13    for i in 0..=100 {
14        let _ = writeln!(
15            progress,
16            "{n} small step for man, {n} giant leap for mankind",
17            n = i
18        );
19
20        progress.pos(i);
21
22        let _ = progress.render();
23        let _ = progress.render();
24
25        thread::sleep(Duration::from_millis(10));
26    }
27
28    let mut lock = progress.finish();
29
30    let _ = writeln!(lock);
31}
Source

pub fn finish(self) -> W

Examples found in repository?
examples/basic.rs (line 28)
7fn main() {
8    let stdout = io::stdout();
9    let lock = stdout.lock();
10
11    let mut progress = Progress::new(lock, 100);
12
13    for i in 0..=100 {
14        let _ = writeln!(
15            progress,
16            "{n} small step for man, {n} giant leap for mankind",
17            n = i
18        );
19
20        progress.pos(i);
21
22        let _ = progress.render();
23        let _ = progress.render();
24
25        thread::sleep(Duration::from_millis(10));
26    }
27
28    let mut lock = progress.finish();
29
30    let _ = writeln!(lock);
31}

Trait Implementations§

Source§

impl<W: Write> Write for Progress<W>

Source§

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
Source§

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<()>

Writes a formatted string into this writer, returning any error encountered. Read more
1.36.0 · Source§

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers. Read more
Source§

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 · Source§

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer. Read more
Source§

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations§

§

impl<W> Freeze for Progress<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for Progress<W>
where W: RefUnwindSafe,

§

impl<W> Send for Progress<W>
where W: Send,

§

impl<W> Sync for Progress<W>
where W: Sync,

§

impl<W> Unpin for Progress<W>
where W: Unpin,

§

impl<W> UnwindSafe for Progress<W>
where W: UnwindSafe,

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<W> DetectColors for W
where W: Write,

Source§

fn available_colors(&mut self) -> Result<u16, Error>

How many ANSI colors are supported (from 8 to 256)? Read more
Source§

impl<W> DetectCursorPos for W
where W: Write,

Source§

fn cursor_pos(&mut self) -> Result<(u16, u16), Error>

Get the (1,1)-based cursor position from the terminal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<W> IntoRawMode for W
where W: Write,

Source§

fn into_raw_mode(self) -> Result<RawTerminal<W>, Error>

Switch to raw mode. 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.