Enum xvc_pipeline::XvcOutput

pub enum XvcOutput {
    File {
        path: XvcPath,
    },
    Metric {
        path: XvcPath,
        format: XvcMetricsFormat,
    },
    Image {
        path: XvcPath,
    },
}

Possible outputs for the pipeline.

These outputs can be defined with xvc pipeline output command.

Variants

File

Fields

path: XvcPath

Path to the file

A (possibly binary) file.

Metric

Fields

path: XvcPath

Path to the file

format: XvcMetricsFormat

Format of the file

A textual metrics file with a known XvcMetricsFormat

Image

Fields

path: XvcPath

Path to the file

An image file, like a plot or generated file

Implementations

impl XvcOutput

pub fn fs_metadata(&self, xvc_root: &XvcRoot) -> Result<Metadata>

Used to check whether pipeline / step output is changed (or missing.)

Trait Implementations

impl Clone for XvcOutput

fn clone(&self) -> XvcOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XvcOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for XvcOutput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for XvcOutput

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

Formats the value using the given formatter.

impl From<&XvcOutput> for XvcPath

fn from(out: &XvcOutput) -> XvcPath

Return the path of a given output

impl From<XvcOutput> for XvcPath

fn from(out: XvcOutput) -> XvcPath

Return the path of a given output

impl Ord for XvcOutput

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<XvcOutput> for XvcOutput

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<XvcOutput> for XvcOutput

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for XvcOutput

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 XvcOutput

fn type_description() -> String

A string representation for the type.

impl Eq for XvcOutput

impl StructuralEq for XvcOutput

impl StructuralPartialEq for XvcOutput