Struct TransferOptions 

pub struct TransferOptions {
    pub chunk_size: usize,
    pub concurrency: usize,
    pub compression: CompressionAlgorithm,
    pub bandwidth_limit: Option<u64>,
    pub retry_policy: RetryPolicy,
    pub verify_on_complete: bool,
    pub hash_algorithm: HashAlgorithm,
    pub resumable: bool,
    pub overwrite: bool,
    pub mode: TransferMode,
    pub preserve_metadata: bool,
}

Options that control how a transfer is performed.

Fields

chunk_size: usize

concurrency: usize

compression: CompressionAlgorithm

bandwidth_limit: Option<u64>

retry_policy: RetryPolicy

verify_on_complete: bool

hash_algorithm: HashAlgorithm

resumable: bool

overwrite: bool

mode: TransferMode

preserve_metadata: bool

Implementations

impl TransferOptions

pub fn with_chunk_size(self, chunk_size: usize) -> TransferOptions

Returns options with the chunk size updated.

Panics

This method does not panic.

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

Returns options with the concurrency updated.

Panics

This method does not panic.

pub fn with_compression( self, compression: CompressionAlgorithm, ) -> TransferOptions

Returns options with the compression algorithm updated.

Panics

This method does not panic.

pub fn with_bandwidth_limit( self, bandwidth_limit: Option<u64>, ) -> TransferOptions

Returns options with the bandwidth limit updated.

Panics

This method does not panic.

pub fn with_retry_policy(self, retry_policy: RetryPolicy) -> TransferOptions

Returns options with the retry policy updated.

Panics

This method does not panic.

pub fn with_verify_on_complete( self, verify_on_complete: bool, ) -> TransferOptions

Returns options with the verify-on-complete flag updated.

Panics

This method does not panic.

pub fn with_hash_algorithm( self, hash_algorithm: HashAlgorithm, ) -> TransferOptions

Returns options with the hash algorithm updated.

Panics

This method does not panic.

pub fn with_resumable(self, resumable: bool) -> TransferOptions

Returns options with the resumable flag updated.

Panics

This method does not panic.

pub fn with_overwrite(self, overwrite: bool) -> TransferOptions

Returns options with the overwrite flag updated.

Panics

This method does not panic.

pub fn with_mode(self, mode: TransferMode) -> TransferOptions

Returns options with the transfer mode updated.

Panics

This method does not panic.

pub fn with_preserve_metadata(self, preserve_metadata: bool) -> TransferOptions

Returns options with metadata preservation updated.

Panics

This method does not panic.

Trait Implementations

impl Clone for TransferOptions

fn clone(&self) -> TransferOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransferOptions

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

Formats the value using the given formatter.

impl Default for TransferOptions

fn default() -> TransferOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransferOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TransferOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.