Enum XvcDependency

pub enum XvcDependency {
    Step(StepDep),
    Generic(GenericDep),
    File(FileDep),
    GlobItems(GlobItemsDep),
    Glob(GlobDep),
    RegexItems(RegexItemsDep),
    Regex(RegexDep),
    Param(ParamDep),
    LineItems(LineItemsDep),
    Lines(LinesDep),
    UrlDigest(UrlDigestDep),
    SqliteQueryDigest(SqliteQueryDep),
}

Represents variety of dependencies Xvc supports. This is to unify all dependencies without dynamic dispatch and having compile time errors when we miss something about dependencies.

Variants

Step(StepDep)

Explicitly defined step depenedencies

Generic(GenericDep)

Dependencies which checks the change of output of a shell command

File(FileDep)

Invalidates when the file content changes.

GlobItems(GlobItemsDep)

Invalidates when contents in any of the files this glob describes. Keeps track of individual files.

Glob(GlobDep)

Invalidates when contents in any of the files this glob describes. Doesn’t keep track of individual files.

RegexItems(RegexItemsDep)

A dependency to a set of lines defined by a regex. Keeps track of individual lines.

Regex(RegexDep)

A dependency to a set of lines defined by a regex. Doesn’t keep track of individual lines.

Param(ParamDep)

A dependency to a parameter in JSON, YAML or TOML file.

LineItems(LineItemsDep)

A dependenci to a set of lines defined by a range. Keeps track of individual lines.

Lines(LinesDep)

A dependenci to a set of lines defined by a range. Doesn’t keep track of individual lines.

UrlDigest(UrlDigestDep)

A dependency to a URL’s content

SqliteQueryDigest(SqliteQueryDep)

A dependency to an SQLite Query, that invalidates when the query results change

Implementations

impl XvcDependency

pub fn xvc_path(&self) -> Option<XvcPath>

Returns the path of the dependency if it has a single path.

pub fn items(&self) -> Option<Vec<String>>

Send a list of items if the dependency has a list of items. Otherwise returns None.

Trait Implementations

impl Clone for XvcDependency

fn clone(&self) -> XvcDependency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XvcDependency

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for XvcDependency

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Diffable for XvcDependency

type Item = XvcDependency

The type of the entity to compare.

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

⚠️ 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. )

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_thorough(record: &Self::Item, actual: &Self::Item) -> Diff<Self::Item>

This is to calculate two entities with a thorough comparison. Example: content of a file, content of a URL etc. You may need to update actual’s content before calling this.

impl Display for XvcDependency

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

Formats the value using the given formatter.

impl From<FileDep> for XvcDependency

fn from(val: FileDep) -> Self

Converts to this type from the input type.

impl From<GenericDep> for XvcDependency

fn from(val: GenericDep) -> Self

Converts to this type from the input type.

impl From<GlobDep> for XvcDependency

fn from(val: GlobDep) -> Self

Converts to this type from the input type.

impl From<GlobItemsDep> for XvcDependency

fn from(val: GlobItemsDep) -> Self

Converts to this type from the input type.

impl From<LineItemsDep> for XvcDependency

fn from(val: LineItemsDep) -> Self

Converts to this type from the input type.

impl From<LinesDep> for XvcDependency

fn from(val: LinesDep) -> Self

Converts to this type from the input type.

impl From<ParamDep> for XvcDependency

fn from(val: ParamDep) -> Self

Converts to this type from the input type.

impl From<RegexDep> for XvcDependency

fn from(val: RegexDep) -> Self

Converts to this type from the input type.

impl From<RegexItemsDep> for XvcDependency

fn from(val: RegexItemsDep) -> Self

Converts to this type from the input type.

impl From<SqliteQueryDep> for XvcDependency

fn from(val: SqliteQueryDep) -> Self

Converts to this type from the input type.

impl From<StepDep> for XvcDependency

fn from(val: StepDep) -> Self

Converts to this type from the input type.

impl From<UrlDigestDep> for XvcDependency

fn from(val: UrlDigestDep) -> Self

Converts to this type from the input type.

impl Ord for XvcDependency

fn cmp(&self, other: &XvcDependency) -> 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 XvcDependency

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

fn partial_cmp(&self, other: &XvcDependency) -> 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 XvcDependency

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 XvcDependency

fn type_description() -> String

A string representation for the type.

impl Eq for XvcDependency

impl StructuralPartialEq for XvcDependency