Struct SyncOptions 

pub struct SyncOptions { /* private fields */ }

Options for extracting a ZIP object from S3 into an S3 prefix.

Implementations

impl SyncOptions

pub fn new(source: S3Object, destination: S3Prefix) -> Self

Creates extract options for a source ZIP object and destination prefix.

pub fn source(&self) -> &S3Object

Returns the source ZIP object.

pub fn destination(&self) -> &S3Prefix

Returns the destination prefix.

pub fn cleanup(&self) -> DestinationCleanup

Returns the destination cleanup policy.

pub fn selection(&self) -> &UnzipSelection

Returns the ZIP entry selection patterns.

pub fn collects_diagnostics(&self) -> bool

Returns whether source scheduler diagnostics are collected.

pub fn comparison_mode(&self) -> ComparisonMode

Returns the ZIP entry comparison policy.

pub fn conflict_policy(&self) -> ConflictPolicy

Returns the conditional write conflict handling policy.

pub fn collects_operations(&self) -> bool

Returns whether per-object operation records are collected.

pub fn concurrency(&self) -> usize

Returns the maximum number of ZIP entries processed concurrently.

pub fn put_concurrency(&self) -> usize

Returns the maximum number of destination PutObject requests in flight.

pub fn put_retry_policy(&self) -> &PutRetryPolicy

Returns the retry and backoff policy for destination PutObject attempts.

pub fn source_block_size(&self) -> usize

Returns the maximum size for planned source ZIP blocks.

pub fn source_block_merge_gap(&self) -> usize

Returns the maximum gap that can be read while coalescing adjacent source spans.

pub fn source_get_concurrency(&self) -> usize

Returns the maximum number of ranged source GetObject requests in flight.

pub fn source_window_capacity(&self) -> usize

Returns the configured source block window capacity.

When Self::with_source_window_memory_budget_mb is used, extraction derives the effective post-manifest value at runtime and reports it in crate::SyncDiagnostics::source_window_capacity when diagnostics are collected.

pub fn source_window_memory_budget_mb(&self) -> Option<u64>

Returns the available memory budget, in MiB, used to derive the source block window.

pub fn body_chunk_size(&self) -> usize

Returns the buffer size used when streaming entry bodies to S3.

pub fn pipe_capacity(&self) -> usize

Returns the in-memory pipe capacity between decompression and S3 upload.

pub fn with_selection(self, selection: impl Into<UnzipSelection>) -> Self

Sets ZIP entry selection patterns.

pub fn delete_extra_objects(self) -> Self

Deletes destination objects under the prefix that are not present in the ZIP.

This requires a non-empty destination prefix and cannot be combined with a non-empty selection.

pub fn with_cleanup(self, cleanup: DestinationCleanup) -> Self

Sets the destination cleanup policy.

pub fn collect_diagnostics(self) -> Self

Collects source scheduler diagnostics in the returned report.

pub fn force_hash_comparison(self) -> Self

Ignores any embedded catalog and hashes ZIP entries for comparison.

pub fn with_comparison_mode(self, comparison: ComparisonMode) -> Self

Sets the ZIP entry comparison policy.

pub fn fail_on_conflict(self) -> Self

Returns an error after the first conditional write conflict is observed.

pub fn with_conflict_policy(self, conflict_policy: ConflictPolicy) -> Self

Sets the conditional write conflict handling policy.

pub fn without_operations(self) -> Self

Omits per-object operation records from the returned report.

pub fn with_concurrency(self, concurrency: usize) -> Self

Sets the maximum number of ZIP entries processed concurrently.

pub fn with_put_concurrency(self, put_concurrency: usize) -> Self

Sets the maximum number of destination PutObject requests in flight.

pub fn with_put_retry_policy(self, put_retry_policy: PutRetryPolicy) -> Self

Sets the retry and backoff policy for destination PutObject attempts.

pub fn with_source_block_size(self, source_block_size: usize) -> Self

Sets the maximum size for planned source ZIP blocks.

pub fn with_source_block_merge_gap(self, source_block_merge_gap: usize) -> Self

Sets the maximum gap that can be read while coalescing adjacent source spans.

pub fn with_source_get_concurrency(self, source_get_concurrency: usize) -> Self

Sets the maximum number of ranged source GetObject requests in flight.

pub fn with_source_window_capacity(self, source_window_capacity: usize) -> Self

Sets the maximum bytes held by the planned source block window.

pub fn with_source_window_memory_budget_mb( self, source_window_memory_budget_mb: u64, ) -> Self

Sets the available memory budget, in MiB, used to derive the source block window.

pub fn with_body_chunk_size(self, body_chunk_size: usize) -> Self

Sets the buffer size used when streaming entry bodies to S3.

pub fn with_pipe_capacity(self, pipe_capacity: usize) -> Self

Sets the in-memory pipe capacity between decompression and S3 upload.

Trait Implementations

impl Clone for SyncOptions

fn clone(&self) -> SyncOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyncOptions

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

Formats the value using the given formatter.