Skip to main content

PvBuilder

Struct PvBuilder 

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

Builder for Pv (FR-043, FR-055). All methods are independent and order-agnostic; each setter is idempotent (last-write-wins). build() is INFALLIBLE.

Implementations§

Source§

impl PvBuilder

Source

pub fn new() -> Self

Fresh builder with all defaults applied:

  • total_bytes: None
  • rate_limit: None
  • buffer_size: 1 MiB
  • interval: 1 second
  • name: None
  • reporter: NoopReporter
Source

pub fn total_bytes(self, n: u64) -> Self

Expected total bytes (-s SIZE).

Source

pub fn rate_limit(self, bytes_per_sec: u64) -> Self

Rate limit in bytes/sec (-L RATE).

Source

pub fn buffer_size(self, n: usize) -> Self

Internal copy-loop buffer size (-B BYTES).

Source

pub fn interval(self, d: Duration) -> Self

Display update interval (-i SEC).

Source

pub fn name(self, name: impl Into<String>) -> Self

Name prefix for the display line (-N NAME).

Source

pub fn reporter(self, r: Box<dyn Reporter>) -> Self

Set a custom progress reporter.

Source

pub fn build(self) -> Pv

Build a configured Pv. INFALLIBLE.

Trait Implementations§

Source§

impl Debug for PvBuilder

Source§

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

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

impl Default for PvBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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.