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
impl Debug for FileProgress
Source§impl Read for FileProgress
impl Read for FileProgress
Source§fn read(&mut self, buf: &mut [u8]) -> Result<usize>
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>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
Like
read
, except that it reads into a slice of buffers. Read moreSource§fn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · Source§fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
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 more1.0.0 · Source§fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
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 more1.6.0 · Source§fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Reads the exact number of bytes required to fill
buf
. Read moreSource§fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
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>
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 more1.0.0 · Source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Creates a “by reference” adaptor for this instance of
Read
. Read moreSource§impl Seek for FileProgress
impl Seek for FileProgress
Source§fn seek(&mut self, pos: SeekFrom) -> Result<u64>
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>
fn rewind(&mut self) -> Result<(), Error>
Rewind to the beginning of a stream. Read more
Source§fn stream_len(&mut self) -> Result<u64, Error>
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
Source§impl WithStepProgress for FileProgress
impl WithStepProgress for FileProgress
fn get_step_progress(&mut self) -> &mut StepProgress
Source§fn with_humanize(self, humanize: bool) -> Self
fn with_humanize(self, humanize: bool) -> Self
Change wether units are converted to human-readable units.
Source§fn with_max_step(self, max_step: usize) -> Self
fn with_max_step(self, max_step: usize) -> Self
Update expected max step.
Source§fn set_max_step(&mut self, max_step: usize)
fn set_max_step(&mut self, max_step: usize)
Update expected max step.
Auto Trait Implementations§
impl Freeze for FileProgress
impl RefUnwindSafe for FileProgress
impl Send for FileProgress
impl Sync for FileProgress
impl Unpin for FileProgress
impl UnwindSafe for FileProgress
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> WithProgress for Twhere
T: WithStepProgress,
impl<T> WithProgress for Twhere
T: WithStepProgress,
fn get_progress(&mut self) -> &mut Progress
Source§fn with_progress(self, progress: Progress) -> Self
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
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
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
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
fn with_extra_infos<S>(self, extra_infos: S) -> Self
Specify extra informations to display.
Source§fn with_output_stream(self, output_stream: OutputStream) -> Self
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
fn with_prefix<S>(self, prefix: S) -> Self
Change the text displayed in front of progress informations. Read more
Source§fn with_refresh_delay(self, refresh_delay: Duration) -> Self
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
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
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
fn with_shape_void(self, shape_void: char) -> Self
Change the character used to draw the background of the progress bar.