Struct TransferState

Source

pub struct TransferState { /* private fields */ }

Expand description

Denotes the mechanism-independent state of one transfer.

Implementations§

Source §

impl TransferState

Source

pub const fn phase(&self) -> TransferPhase

Observes the transfer phase.

Source

pub fn destination(&self) -> Option<&Path>

Observes the final destination when known.

Source

pub const fn downloaded(&self) -> u64

Observes retrieved bytes.

Source

pub const fn total(&self) -> Option<u64>

Observes expected bytes when known.

Source

pub const fn elapsed(&self) -> Duration

Observes elapsed transfer time.

Source

pub const fn terminal(&self) -> Option<&DownloadEvent>

Observes the terminal download event when one occurred.

Source

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

Observes the concise user-facing failure summary.

Source

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

Observes detailed diagnostics.

Trait Implementations§

Source §

impl Clone for TransferState

Source §

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Source §

impl Debug for TransferState

Source §

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

Formats the value using the given formatter. Read more

Source §

impl PartialEq for TransferState

Source §

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Source §

impl StructuralPartialEq for TransferState

Source §

impl TransferViewAlg for TransferState

Source §

fn transfer_total(&self) -> Option<u64>

Observes expected bytes when the source states them.

Source §

fn transfer_elapsed(&self) -> Duration

Observes elapsed transfer time.

Source §

fn transfer_complete(&self) -> bool

Observes whether the transfer reached terminal success.

Source §

fn transfer_destination(&self) -> Option<&Path>

Observes the path publication will produce once an interpreter states one.

Source §

fn transfer_summary(&self) -> Option<&str>

Observes the concise reason a transfer failed.

Source §

fn transfer_detail(&self) -> Option<&str>

Observes the diagnostic accompanying a failure.

Auto Trait Implementations§

§

impl RefUnwindSafe for TransferState

§

impl UnsafeUnpin for TransferState

§

impl UnwindSafe for TransferState

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> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<This> GaugeLaws<This> for This

Source §

fn gauge_laws(&self) -> Result<(), Error>

Checks that a gauge states a share without claiming more resolution than it has.

The laws checked are:

a gauge occupies its stated width whatever share it states;
no share is stated as filled before it is reached, and none is stated twice;
nothing stated is nothing filled, and everything stated fills the whole track;
the stated text occupies exactly one cell per counted cell.

§Errors

Returns the first violated law.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

impl<This> IntoExt<This> for This

Source §

fn to<R>(self) -> R
where This: Into<R>,

A version of Into::into function that can be used to explicitly specify the target conversion type.

use alux_sdk::*;
// `Into` requires context to infer the type,
let _: i64 = Into::into(42_i8);
// The opposite `From` requires context to infer the type,
let _: i64 = From::from(42_i8);
// `.to()` can be used in the same way as a postfix function (the same as `.into()`),
let _: i64 = 42_i8.to();
// but also with the type specified explicitly.
let _ = 42_i8.to::<i64>();
// Especially useful to chain multiple conversions inline.
let _: i64 = 42_i8.to::<i16>().to::<i32>().into();

Source §

impl<This> IntoIteratorExt<This> for This

Source §

fn try_collect_vec<T, E>(self) -> Result<Vec<T>, E>
where This: Iterator<Item = Result<T, E>>,

A variant of the try_collect and collect_vec combined function from the Itertools library. The materialized value is a Vec inside a Result object.

Returns the first error without collecting later values.

use alux_sdk::*;

let values = [Ok::<_, &str>(1), Ok(2), Ok(3)]
    .into_iter()
    .try_collect_vec();

assert_eq!(values, Ok(vec![1, 2, 3]));

Source §

fn collect_exact<T>(self, n: usize) -> Option<Vec<T>>
where This: Iterator<Item = T>,

Takes exactly n elements from the iterator.

Returns Some(Vec<T>) if the iterator yields exactly n elements, otherwise returns None.

use alux_sdk::*;

let v = [1, 2, 3];

assert_eq!(v.iter().copied().collect_exact(3), Some(vec![1, 2, 3]));
assert_eq!(v.iter().copied().collect_exact(4), None);
assert_eq!(v.iter().copied().collect_exact(2), None);

Source §

fn try_unzip<A, B, E>(self) -> Result<(Vec<A>, Vec), E>
where This: IntoIterator<Item = Result<(A, B), E>>,

Efficiently splits an iterator of Result<(A, B), E> into two Vecs, short-circuiting on error.

Consumes the iterator, collecting all A elements into one vector and all B elements into another, without first allocating an intermediate vector of tuples. Returns the tuple (Vec<A>, Vec) on success, or the first error encountered.

use alux_sdk::*;

let input = vec![Ok((1, "x")), Ok((2, "y"))];
let (xs, ys) = input.try_unzip::<_, _, ()>().unwrap();

assert_eq!(xs, vec![1, 2]);
assert_eq!(ys, vec!["x", "y"]);

Source §

impl<T> ToOwned for T
where T: Clone,

Source §

type Owned = T

The resulting type after obtaining ownership.

Source §

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

Source §

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

Source §

impl<This> TransferProgressExt<This> for This
where This: TransferViewAlg,

Source §

fn bytes_per_second(&self) -> Option<u64>

Derives average retrieved bytes per second once progress has duration.

Source §

fn estimated_remaining(&self) -> Option<Duration>

Derives remaining time from average progress once the expected byte count is known.

Source §

fn percent(&self) -> Option<u16>

Derives the completed share as whole percent once it is known.

Source §

impl<T, U> TryFrom for T
where U: Into<T>,

Source §

type Error = !

The type returned in the event of a conversion error.

Source §

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

TransferState

Struct TransferState Copy item path

Implementations§

impl TransferState

pub const fn phase(&self) -> TransferPhase

pub fn destination(&self) -> Option<&Path>

pub const fn downloaded(&self) -> u64

pub const fn total(&self) -> Option<u64>

pub const fn elapsed(&self) -> Duration

pub const fn terminal(&self) -> Option<&DownloadEvent>

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

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

Trait Implementations§

impl Clone for TransferState

fn clone(&self) -> Self

fn clone_from(&mut self, source: &Self)

impl Debug for TransferState

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

impl Eq for TransferState

impl PartialEq for TransferState

fn eq(&self, other: &Self) -> bool

fn ne(&self, other: &Rhs) -> bool

impl StructuralPartialEq for TransferState

impl TransferViewAlg for TransferState

fn transferred(&self) -> u64

fn transfer_total(&self) -> Option<u64>

fn transfer_elapsed(&self) -> Duration

fn transfer_complete(&self) -> bool

fn transfer_destination(&self) -> Option<&Path>

fn transfer_summary(&self) -> Option<&str>

fn transfer_detail(&self) -> Option<&str>

Auto Trait Implementations§

impl Freeze for TransferState

impl RefUnwindSafe for TransferState

impl Send for TransferState

impl Sync for TransferState

impl Unpin for TransferState

impl UnsafeUnpin for TransferState

impl UnwindSafe for TransferState

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<This> GaugeLaws<This> for This

fn gauge_laws(&self) -> Result<(), Error>

§Errors

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘwhere F: FnOnce(&Self) -> bool,

impl<This> IntoExt<This> for This

fn to<R>(self) -> Rwhere This: Into<R>,

impl<This> IntoIteratorExt<This> for This

fn try_collect_vec<T, E>(self) -> Result<Vec<T>, E>where This: Iterator<Item = Result<T, E>>,

fn collect_exact<T>(self, n: usize) -> Option<Vec<T>>where This: Iterator<Item = T>,

fn try_unzip<A, B, E>(self) -> Result<(Vec<A>, Vec<B>), E>where This: IntoIterator<Item = Result<(A, B), E>>,

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<This> TransferProgressExt<This> for Thiswhere This: TransferViewAlg,

fn bytes_per_second(&self) -> Option<u64>

fn estimated_remaining(&self) -> Option<Duration>

fn percent(&self) -> Option<u16>

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = !

fn try_from(value: U) -> Result<T, !>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct TransferState

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

fn to<R>(self) -> R
where This: Into<R>,

fn try_collect_vec<T, E>(self) -> Result<Vec<T>, E>
where This: Iterator<Item = Result<T, E>>,

fn collect_exact<T>(self, n: usize) -> Option<Vec<T>>
where This: Iterator<Item = T>,

fn try_unzip<A, B, E>(self) -> Result<(Vec<A>, Vec<B>), E>
where This: IntoIterator<Item = Result<(A, B), E>>,

impl<T> ToOwned for T
where T: Clone,

impl<This> TransferProgressExt<This> for This
where This: TransferViewAlg,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,