Skip to main content

Pv

Struct Pv 

Source
#[non_exhaustive]
pub struct Pv { /* private fields */ }
Expand description

Configured pipe-viewer runner. Construct via PvBuilder.

Implementations§

Source§

impl Pv

Source

pub fn copy<R: Read + ?Sized, W: Write + ?Sized>( self, reader: &mut R, writer: &mut W, ) -> Result<u64, PvError>

Stream readerwriter while reporting progress to the configured reporter. Returns the number of bytes transferred or an error (FR-046).

§Errors

Returns PvError::Io on any I/O failure during read or write.

Source

pub fn total_bytes(&self) -> Option<u64>

Configured total-byte hint (-s SIZE).

Source

pub fn rate_limit(&self) -> Option<u64>

Configured rate limit in bytes/sec (-L RATE).

Source

pub fn buffer_size(&self) -> usize

Configured internal buffer size (-B BYTES).

Source

pub fn interval(&self) -> Duration

Configured display interval (-i SEC).

Source

pub fn name(&self) -> Option<&str>

Configured name (-N NAME).

Trait Implementations§

Source§

impl Debug for Pv

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Pv

§

impl !RefUnwindSafe for Pv

§

impl Send for Pv

§

impl !Sync for Pv

§

impl Unpin for Pv

§

impl UnsafeUnpin for Pv

§

impl !UnwindSafe for Pv

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.