Struct UpdateInfoAndProgress

pub struct UpdateInfoAndProgress { /* private fields */ }

An UpdateInfo and Progress that are guaranteed to be consistent with each other.

Specifically, progress.bytes_downloaded <= info.download_size.

Implementations

impl UpdateInfoAndProgress

pub fn builder() -> UpdateInfoAndProgressBuilder

Starts building an instance of UpdateInfoAndProgress.

pub fn new( info: UpdateInfo, progress: Progress, ) -> Result<Self, BytesFetchedExceedsDownloadSize>

Constructs an UpdateInfoAndProgress from the 2 fields, ensuring that the 2 structs are consistent with each other, returning an error if they are not.

pub fn done(info: UpdateInfo) -> Self

Constructs an UpdateInfoAndProgress from an UpdateInfo, setting the progress fields to be 100% done with all bytes downloaded.

pub fn info(&self) -> UpdateInfo

Returns the info field.

pub fn progress(&self) -> &Progress

Returns the progress field.

pub fn with_stage_reason(self, reason: StageFailureReason) -> FailStageData

Constructs a FailStageData with the given reason.

pub fn with_fetch_reason(self, reason: FetchFailureReason) -> FailFetchData

Constructs a FailFetchData with the given reason.

Trait Implementations

impl Arbitrary for UpdateInfoAndProgress

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<UpdateInfoAndProgress>

The type of Strategy used to generate values of type Self.

fn arbitrary_with((): Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for UpdateInfoAndProgress

fn clone(&self) -> UpdateInfoAndProgress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateInfoAndProgress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UpdateInfoAndProgress

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UpdateInfoAndProgress

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for UpdateInfoAndProgress

fn partial_cmp(&self, other: &UpdateInfoAndProgress) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for UpdateInfoAndProgress

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for UpdateInfoAndProgress

impl StructuralPartialEq for UpdateInfoAndProgress