Struct EffectiveSource 

pub struct EffectiveSource {
    pub index: usize,
    pub pvc: Option<PvcTargetRef>,
    pub nfs_path: Option<String>,
    pub stream: Option<StreamSource>,
    pub source_path_override: Option<String>,
    pub read_only: bool,
}

The single source one Snapshot actually backs up, after resolving spec.source (a fanned-out child) against the policy’s sources[].

Fields

index: usize

Index into policy.spec.sources these knobs came from.

pvc: Option<PvcTargetRef>

The concrete PVC, when this is a PVC-shaped source.

nfs_path: Option<String>

The NFS export path, when this is an NFS source.

stream: Option<StreamSource>

The stream producer, when this is a stream source. Mounts nothing: the mover execs a command and pipes its stdout into kopia, so no pvc/nfs_path is set and read_only is meaningless (see EffectiveSource::read_only).

source_path_override: Option<String>

sourcePathOverride from the governing source.

read_only: bool

Whether the mount is read-only.

Implementations

impl EffectiveSource

pub fn kopia_source_path(&self, strategy: SourcePathStrategy) -> Option<String>

The kopia source path (and mount path) for this run.

sourcePathOverride wins. Otherwise a PVC yields /pvc/<name> or /pvc/<namespace>/<name> depending on the governing source’s SourcePathStrategy, and an NFS source yields its export path.

The pvc-before-stream order is safe because the combination is UNREPRESENTABLE, not because PVC is the better guess: a Source is exactly-one-of, and effective_source_in refuses a PVC pin against a source that is not PVC-shaped (see the comment there for what the divergence used to cost). Every other constructor sets stream: None wherever it sets pvc. Anything that starts building an EffectiveSource with both must decide which path is authoritative FIRST — the two consumers (identity_source_path, which records the manifest, and snapshot::build, which fills the work spec) do not read this function the same way.

Trait Implementations

impl Clone for EffectiveSource

fn clone(&self) -> EffectiveSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EffectiveSource

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

Formats the value using the given formatter.

impl PartialEq for EffectiveSource

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for EffectiveSource