Struct RegexDep

pub struct RegexDep {
    pub path: XvcPath,
    pub regex: String,
    pub lines_digest: Option<ContentDigest>,
    pub xvc_metadata: Option<XvcMetadata>,
}

When a step depends to a regex search in a text file

Fields

path: XvcPath

Path of the file in the workspace

regex: String

The regex to search in the file

lines_digest: Option<ContentDigest>

The digest of the lines that match the regex

xvc_metadata: Option<XvcMetadata>

The metadata of the file

Implementations

impl RegexDep

pub fn new(path: XvcPath, regex: String) -> Self

Create a new RegexDep with empty metadata and digest

pub fn update_metadata(self, xvc_metadata: Option<XvcMetadata>) -> Self

Update the metadata of the file

pub fn update_digest(self, xvc_root: &XvcRoot, algorithm: HashAlgorithm) -> Self

Update the digest of the file by reading the file and collecting all lines that match the regex

pub fn regex(&self) -> Regex

Returns the inner regex

Trait Implementations

impl Clone for RegexDep

fn clone(&self) -> RegexDep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegexDep

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RegexDep

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Diffable for RegexDep

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

⚠️ Update the metadata with actual.update_metadata before calling this function

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

⚠️ Update the metadata and lines with actual.update_digest before calling this function

type Item = RegexDep

The type of the entity to compare.

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<RegexDep> for XvcDependency

fn from(val: RegexDep) -> Self

Converts to this type from the input type.

impl Ord for RegexDep

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

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

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

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 RegexDep

fn type_description() -> String

A string representation for the type.

impl Eq for RegexDep

impl StructuralPartialEq for RegexDep