Skip to main content

SyncToOptions

Struct SyncToOptions 

Source
pub struct SyncToOptions {
    pub parallel: Option<u32>,
    pub delete_extra: bool,
    pub must_exist: Option<bool>,
    pub times: Option<bool>,
    pub update: Option<bool>,
    pub max_download_speed_bytes_per_second: Option<i64>,
    pub max_upload_speed_bytes_per_second: Option<i64>,
}
Expand description

Options for kopia repository sync-to (ADR-0005 §13(d) / issue #216). Every field’s None/false reproduces kopia’s own default — an all-None, delete_extra: false instance yields the exact same argv sync_to_args produced before this struct existed. The tri-state booleans map to kopia’s --[no-]flag grammar, same as RestoreOptions: Some(true)--flag, Some(false)--no-flag, None → omit (kopia default).

Fields§

§parallel: Option<u32>

--parallel: copy parallelism to the destination (kopia default 1 — sequential; the root cause of #216’s multi-week initial-seed times).

§delete_extra: bool

--delete: prune destination-only blobs for a true mirror (kopia default false — additive sync, never removes destination content).

§must_exist: Option<bool>

--[no-]must-exist: fail instead of initializing the destination’s repository-format blob (kopia default false).

§times: Option<bool>

--[no-]times: synchronize blob modification times to the destination, when supported (kopia default true).

§update: Option<bool>

--[no-]update: update blobs already present at the destination when the source copy is newer (kopia default true).

§max_download_speed_bytes_per_second: Option<i64>

--max-download-speed: cap read throughput from the source, bytes/sec (kopia default: unlimited).

§max_upload_speed_bytes_per_second: Option<i64>

--max-upload-speed: cap write throughput to the destination, bytes/sec (kopia default: unlimited).

Trait Implementations§

Source§

impl Clone for SyncToOptions

Source§

fn clone(&self) -> SyncToOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SyncToOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SyncToOptions

Source§

fn default() -> SyncToOptions

Returns the “default value” for a type. Read more
Source§

impl Eq for SyncToOptions

Source§

impl PartialEq for SyncToOptions

Source§

fn eq(&self, other: &SyncToOptions) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SyncToOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more