Skip to main content

TransferProgress

Struct TransferProgress 

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

Progress display for rsync transfers.

Implementations§

Source§

impl TransferProgress

Source

pub fn new( ctx: OutputContext, direction: TransferDirection, label: impl Into<String>, quiet: bool, ) -> Self

Create a new transfer progress display.

Source

pub fn upload(ctx: OutputContext, label: impl Into<String>, quiet: bool) -> Self

Convenience constructor for uploads.

Source

pub fn download( ctx: OutputContext, label: impl Into<String>, quiet: bool, ) -> Self

Convenience constructor for downloads.

Source

pub fn update_from_line(&mut self, line: &str)

Update progress from a raw rsync output line.

Source

pub fn set_current_file(&mut self, path: impl Into<String>)

Set the current file being transferred.

Source

pub fn set_compression_ratio(&mut self, ratio: f64)

Set compression ratio (e.g. 3.2 for 3.2:1).

Source

pub fn apply_summary(&mut self, bytes_transferred: u64, files_transferred: u32)

Apply a final summary from an external source.

Useful when progress lines are unavailable (e.g., mock transport).

Source

pub fn stats(&self) -> TransferStats

Snapshot current transfer stats for callers.

Source

pub fn finish(&mut self)

Finish the progress display and print a summary line.

Source

pub fn finish_error(&mut self, message: &str)

Finish with a failure message.

Trait Implementations§

Source§

impl Debug for TransferProgress

Source§

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

Formats the value using the given formatter. 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more