Enum iroh_blobs::get::db::DownloadProgress

pub enum DownloadProgress {
    InitialState(TransferState),
    FoundLocal {
        child: BlobId,
        hash: Hash,
        size: BaoBlobSize,
        valid_ranges: RangeSpec,
    },
    Connected,
    Found {
        id: u64,
        child: BlobId,
        hash: Hash,
        size: u64,
    },
    FoundHashSeq {
        hash: Hash,
        children: u64,
    },
    Progress {
        id: u64,
        offset: u64,
    },
    Done {
        id: u64,
    },
    AllDone(Stats),
    Abort(Error),
}

Progress updates for the get operation.

Variants

InitialState(TransferState)

Initial state if subscribing to a running or queued transfer.

FoundLocal

Data was found locally.

Fields

child: BlobId

child offset

hash: Hash

The hash of the entry.

size: BaoBlobSize

The size of the entry in bytes.

valid_ranges: RangeSpec

The ranges that are available locally.

Connected

A new connection was established.

Found

An item was found with hash hash, from now on referred to via id.

Fields

id: u64

A new unique progress id for this entry.

child: BlobId

Identifier for this blob within this download.

Will always be BlobId::Root unless a hashseq is downloaded, in which case this allows to identify the children by their offset in the hashseq.

hash: Hash

The hash of the entry.

size: u64

The size of the entry in bytes.

FoundHashSeq

An item was found with hash hash, from now on referred to via id.

Fields

hash: Hash

The name of the entry.

children: u64

Number of children in the collection, if known.

Progress

We got progress ingesting item id.

Fields

id: u64

The unique id of the entry.

offset: u64

The offset of the progress, in bytes.

Done

We are done with id.

Fields

id: u64

The unique id of the entry.

AllDone(Stats)

All operations finished.

This will be the last message in the stream.

Abort(Error)

We got an error and need to abort.

This will be the last message in the stream.

Trait Implementations

impl Clone for DownloadProgress

fn clone(&self) -> DownloadProgress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DownloadProgress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DownloadProgress

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DownloadProgress> for DownloadResponse

Available on crate feature rpc only.

fn from(value: DownloadProgress) -> Self

Converts to this type from the input type.

impl From<DownloadResponse> for DownloadProgress

Available on crate feature rpc only.

fn from(value: DownloadResponse) -> Self

Converts to this type from the input type.

impl Serialize for DownloadProgress

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

where __S: Serializer,

Serialize this value into the given Serde serializer.