Skip to main content

StdinSnapshot

Struct StdinSnapshot 

Source
pub struct StdinSnapshot<'a> {
    pub source_path: &'a str,
    pub stdin_file: &'a str,
    pub tags: &'a BTreeMap<String, String>,
    pub override_source: Option<&'a str>,
    pub opts: &'a SnapshotCreateOptions,
    pub finalize_timeout: Option<Duration>,
}
Expand description

Everything a stdin-fed snapshot needs except the producer itself.

A named struct rather than six positional parameters, for one specific reason beyond the argument count: source_path and stdin_file are both &str and are trivially transposable at a call site. Swapping them would record the snapshot under the FILE name as its kopia source path — a silent identity change, which orphans the whole history for that source and is exactly the class of mistake this repo builds types to prevent.

Fields§

§source_path: &'a str

The VIRTUAL root kopia records the artifact under, e.g. /stream/postgres.sql. Nothing is read from the pod’s filesystem.

§stdin_file: &'a str

The single virtual file name stored inside that root, e.g. postgres.sql. Becomes kopia’s --stdin-file.

§tags: &'a BTreeMap<String, String>

Tags to stamp on the manifest.

§override_source: Option<&'a str>

username@hostname:path identity to record, overriding the mover pod’s ambient user/host.

§opts: &'a SnapshotCreateOptions

snapshot create argv options.

§finalize_timeout: Option<Duration>

How long kopia may take to FINALIZE after the writer closes. None falls back to the client’s default_timeout, then DEFAULT_STDIN_FINALIZE_TIMEOUT — never unbounded. Callers derive it from the producer’s own timeout plus STDIN_FINALIZE_GRACE.

Trait Implementations§

Source§

impl<'a> Clone for StdinSnapshot<'a>

Source§

fn clone(&self) -> StdinSnapshot<'a>

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<'a> Debug for StdinSnapshot<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for StdinSnapshot<'a>

§

impl<'a> RefUnwindSafe for StdinSnapshot<'a>

§

impl<'a> Send for StdinSnapshot<'a>

§

impl<'a> Sync for StdinSnapshot<'a>

§

impl<'a> Unpin for StdinSnapshot<'a>

§

impl<'a> UnsafeUnpin for StdinSnapshot<'a>

§

impl<'a> UnwindSafe for StdinSnapshot<'a>

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