Struct FileDep

pub struct FileDep {
    pub path: XvcPath,
    pub xvc_metadata: Option<XvcMetadata>,
    pub content_digest: Option<ContentDigest>,
}

A file dependency for a pipeline step. It keeps track of path, metadata and the digest of the file.

Fields

path: XvcPath

The path in the workspace

xvc_metadata: Option<XvcMetadata>

XvcMetadata of the file if it’s available

content_digest: Option<ContentDigest>

ContentDigest of the file if it’s available

Implementations

impl FileDep

pub fn new(path: XvcPath) -> Self

Create a new file dependency with metadata and digest set to None.

pub fn from_pmp(path: &XvcPath, pmp: &XvcPathMetadataProvider) -> Result<Self>

Create a file dependency with the given path and metadata obtained from [XvcPathMetadataMap]

pub fn calculate_content_digest( self, xvc_root: &XvcRoot, algorithm: HashAlgorithm, text_or_binary: TextOrBinary, ) -> Result<Self>

Returns a new instance with the updated content digest

pub fn calculate_content_digest_if_changed( self, xvc_root: &XvcRoot, record: &Self, algorithm: HashAlgorithm, text_or_binary: TextOrBinary, ) -> Result<Self>

Returns a new instance with a new content digest if the metadata has changed

Trait Implementations

impl Clone for FileDep

fn clone(&self) -> FileDep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileDep

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileDep

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Diffable for FileDep

fn diff_thorough(record: &Self::Item, actual: &Self::Item) -> Diff<Self::Item>

⚠️ Call actual.update_metadata and actual.calculate_content_digest_if_changed before calling this ⚠️

type Item = FileDep

The type of the entity to compare.

fn diff_superficial( record: &Self::Item, actual: &Self::Item, ) -> Diff<Self::Item>

This is to compare two entities with a quick comparison. Example: metadata of a file, timestamp of a URL etc. You may need to update actual’s metadata or timestamp before calling this.

fn diff( record: Option<&Self::Item>, actual: Option<&Self::Item>, ) -> Diff<Self::Item>

⚠️ Usually you must update actual’s metadata and timestamp before calling this. Use diff_superficial and diff_thorough for shortcut comparisons. (e.g. when metadata is not changed, no need to compare the content. )

impl From<FileDep> for XvcDependency

fn from(val: FileDep) -> Self

Converts to this type from the input type.

impl Ord for FileDep

fn cmp(&self, other: &FileDep) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FileDep

fn eq(&self, other: &FileDep) -> 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 PartialOrd for FileDep

fn partial_cmp(&self, other: &FileDep) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for FileDep

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Storable for FileDep

fn type_description() -> String

A string representation for the type.

impl Eq for FileDep

impl StructuralPartialEq for FileDep