Enum iroh_bytes::provider::ShareProgress

pub enum ShareProgress {
    Connected,
    Found {
        id: u64,
        hash: Hash,
        size: u64,
    },
    FoundCollection {
        hash: Hash,
        num_blobs: Option<u64>,
        total_blobs_size: Option<u64>,
    },
    Progress {
        id: u64,
        offset: u64,
    },
    Done {
        id: u64,
    },
    NetworkDone {
        bytes_written: u64,
        bytes_read: u64,
        elapsed: Duration,
    },
    Export {
        id: u64,
        hash: Hash,
        size: u64,
        target: String,
    },
    ExportProgress {
        id: u64,
        offset: u64,
    },
    Abort(RpcError),
    AllDone,
}

Progress updates for the provide operation.

Variants

Connected

A new connection was established.

Found

Fields

id: u64

A new unique id for this entry.

hash: Hash

The name of the entry.

size: u64

The size of the entry in bytes.

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

FoundCollection

Fields

hash: Hash

The name of the entry.

num_blobs: Option<u64>

Number of children in the collection, if known.

total_blobs_size: Option<u64>

The size of the entry in bytes, if known.

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

Progress

Fields

id: u64

The unique id of the entry.

offset: u64

The offset of the progress, in bytes.

We got progress ingesting item id.

Done

Fields

id: u64

The unique id of the entry.

We are done with id, and the hash is hash.

NetworkDone

Fields

bytes_written: u64

The number of bytes written.

bytes_read: u64

The number of bytes read.

elapsed: Duration

The time it took to transfer the data.

We are done with the network part - all data is local.

Export

Fields

id: u64

Unique id of the entry.

hash: Hash

The hash of the entry.

size: u64

The size of the entry in bytes.

target: String

The path to the file where the data is exported.

The download part is done for this id, we are now exporting the data to the specified out path.

ExportProgress

Fields

id: u64

Unique id of the entry that is being exported.

offset: u64

The offset of the progress, in bytes.

We have made progress exporting the data.

This is only sent for large blobs.

Abort(RpcError)

We got an error and need to abort.

AllDone

We are done with the whole operation.

Trait Implementations

impl Debug for ShareProgress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShareProgress

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ShareProgress

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

Serialize this value into the given Serde serializer.