Struct FileProgress

Source
pub struct FileProgress { /* private fields */ }
Expand description

A wrapper read only stream arround a file.

§Example

use prog_rs::prelude::*;

let f = File::open("../../data/addresses/bano.csv")
    .unwrap()
    .progress()
    .with_prefix(" Read file ...")
    .with_bar_position(BarPosition::Right);
let f = BufReader::new(f);
println!("This file has {} lines", f.lines().count());

Trait Implementations§

Source§

impl Debug for FileProgress

Source§

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

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

impl Read for FileProgress

Source§

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
1.36.0 · Source§

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

Like read, except that it reads into a slice of buffers. Read more
Source§

fn is_read_vectored(&self) -> bool

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

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf. Read more
1.0.0 · Source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · Source§

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

Reads the exact number of bytes required to fill buf. Read more
Source§

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Pull some bytes from this source into the specified buffer. Read more
Source§

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Reads the exact number of bytes required to fill cursor. Read more
1.0.0 · Source§

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

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · Source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · Source§

fn chain<R>(self, next: R) -> Chain<Self, R>
where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another. Read more
1.0.0 · Source§

fn take(self, limit: u64) -> Take<Self>
where Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more
Source§

impl Seek for FileProgress

Source§

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream. Read more
1.55.0 · Source§

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

Rewind to the beginning of a stream. Read more
Source§

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)
Returns the length of this stream (in bytes). Read more
1.51.0 · Source§

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream. Read more
1.80.0 · Source§

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position. Read more
Source§

impl WithStepProgress for FileProgress

Source§

fn get_step_progress(&mut self) -> &mut StepProgress

Source§

fn with_humanize(self, humanize: bool) -> Self

Change wether units are converted to human-readable units.
Source§

fn with_unit<S: Into<String>>(self, unit: S) -> Self

Change displayed unit.
Source§

fn with_max_step(self, max_step: usize) -> Self

Update expected max step.
Source§

fn set_max_step(&mut self, max_step: usize)

Update expected max step.
Source§

fn max_step(&mut self) -> Option<usize>

Get expected max step.
Source§

fn cur_step(&mut self) -> usize

Get current step.

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> 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<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<T> WithProgress for T

Source§

fn get_progress(&mut self) -> &mut Progress

Source§

fn with_progress(self, progress: Progress) -> Self

Specify a progress bar to use, which allows to copy configuration. Read more
Source§

fn with_bar_position(self, bar_position: BarPosition) -> Self

Change the style of the bar disposition.
Source§

fn with_bar_width(self, bar_width: usize) -> Self

Change the width of the progress bar.
Source§

fn with_display_width(self, display_width: usize) -> Self

Change the width of the text the displayed informations should try to fit in. The terminal width will be detected by default.
Source§

fn with_extra_infos<S>(self, extra_infos: S) -> Self
where S: Into<String>,

Specify extra informations to display.
Source§

fn with_output_stream(self, output_stream: OutputStream) -> Self

Change the output stream the progress bar is displayed in. By default standart output is used.
Source§

fn with_prefix<S>(self, prefix: S) -> Self
where S: Into<String>,

Change the text displayed in front of progress informations. Read more
Source§

fn with_refresh_delay(self, refresh_delay: Duration) -> Self

Change the minimum delay between two display updates.
Source§

fn with_shape_body(self, shape_body: char) -> Self

Change the character used to draw the body of the progress bar.
Source§

fn with_shape_head(self, shape_head: char) -> Self

Change the character used to draw the head of the progress bar.
Source§

fn with_shape_void(self, shape_void: char) -> Self

Change the character used to draw the background of the progress bar.