Struct ParamDep

pub struct ParamDep {
    pub format: XvcParamFormat,
    pub path: XvcPath,
    pub key: String,
    pub value: Option<XvcParamValue>,
    pub xvc_metadata: Option<XvcMetadata>,
}

Invalidates when key in params file in path changes.

Fields

format: XvcParamFormat

Format of the params file. This is inferred from extension if not given.

path: XvcPath

Path of the file in the workspace

key: String

Key like mydict.mykey to access the value

value: Option<XvcParamValue>

The value of the key

xvc_metadata: Option<XvcMetadata>

The metadata of the parameter file to detect if it has changed

Implementations

impl ParamDep

pub fn new( path: &XvcPath, format: Option<XvcParamFormat>, key: String, ) -> Result<Self>

Creates a new ParamDep with the given path and key. If the format is None, it’s inferred from the path.

pub fn update_metadata(self, pmp: &XvcPathMetadataProvider) -> Result<Self>

Update metada from the XvcPathMetadataProvider

pub fn update_value(self, xvc_root: &XvcRoot) -> Result<Self>

Update value by reading the file

Trait Implementations

impl Clone for ParamDep

fn clone(&self) -> ParamDep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamDep

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParamDep

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Diffable for ParamDep

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

⚠️ Call actual.update_metadata before calling this function ⚠️

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

⚠️ Call actual.update_metadata and actual.update_value before calling this function ⚠️

type Item = ParamDep

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

fn from(val: ParamDep) -> Self

Converts to this type from the input type.

impl Ord for ParamDep

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

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

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

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 ParamDep

fn type_description() -> String

A string representation for the type.

impl Eq for ParamDep

impl StructuralPartialEq for ParamDep