Struct ssstar::CreateArchiveJob

pub struct CreateArchiveJob { /* private fields */ }

A job which will create a new tar archive from object store inputs.

Implementations

impl CreateArchiveJob

pub fn total_bytes(&self) -> u64

The total number of bytes to read from all objects

pub fn total_objects(&self) -> usize

The total number of objects included in this archive

pub async fn run_without_progress( self, abort: impl Future<Output = ()> ) -> Result<()>

Alternative to Self::run which doesn’t require a [ProgressCallback] implementation, for callers that do not care about progress information.

pub async fn run<Abort, Progress>( self, _abort: Abort, progress: Progress ) -> Result<()>where Abort: Future<Output = ()>, Progress: CreateProgressCallback + 'static,

Run the job, returning only when the job has run to completion (or failed)

If the abort future is completed, it’s a signal that the job should be aborted. Existing transfers will be abandoned and queued transfers will be dropped, then this method returns an abort error.

Trait Implementations

impl Debug for CreateArchiveJob

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

Formats the value using the given formatter.