Enum xvc_pipeline::PipelineSubCommand

pub enum PipelineSubCommand {
    New {
        name: String,
        workdir: Option<PathBuf>,
    },
    Update {
        name: Option<String>,
        rename: Option<String>,
        workdir: Option<PathBuf>,
        set_default: bool,
    },
    Delete {
        name: String,
    },
    Run {
        name: Option<String>,
    },
    List,
    Dag {
        name: Option<String>,
        file: Option<PathBuf>,
        format: XvcPipelineDagFormat,
    },
    Export {
        name: Option<String>,
        file: Option<PathBuf>,
        format: Option<XvcSchemaSerializationFormat>,
    },
    Import {
        name: Option<String>,
        file: Option<PathBuf>,
        format: Option<XvcSchemaSerializationFormat>,
        overwrite: bool,
    },
    Step(StepCLI),
}

Pipeline management subcommands

Variants

New

Fields

name: String

Name of the pipeline this command applies to

workdir: Option<PathBuf>

Default working directory

Create a new pipeline

Update

Fields

name: Option<String>

Name of the pipeline this command applies to

rename: Option<String>

Rename the pipeline to

workdir: Option<PathBuf>

Set the working directory

set_default: bool

Set this pipeline as default

Rename, change dir or set a pipeline as default

Delete

Fields

name: String

Name or GUID of the pipeline to be deleted

Delete a pipeline

Run

Fields

name: Option<String>

Name of the pipeline to run

Run a pipeline

List

List all pipelines

Dag

Fields

name: Option<String>

Name of the pipeline to generate the diagram

file: Option<PathBuf>

Output file. Writes to stdout if not set.

format: XvcPipelineDagFormat

Format for graph. Either dot or mermaid.

Generate a dot or mermaid diagram for the pipeline

Export

Fields

name: Option<String>

Name of the pipeline to export

file: Option<PathBuf>

File to write the pipeline. Writes to stdout if not set.

format: Option<XvcSchemaSerializationFormat>

Output format. One of json or yaml. If not set, the format is guessed from the file extension. If the file extension is not set, json is used as default.

Export the pipeline to a YAML or JSON file to edit

Import

Fields

name: Option<String>

Name of the pipeline to import. If not set, the name from the file is used.

file: Option<PathBuf>

File to read the pipeline. Use stdin if not specified.

format: Option<XvcSchemaSerializationFormat>

Input format. One of json or yaml. If not set, the format is guessed from the file extension. If the file extension is not set, json is used as default.

overwrite: bool

Overwrite the pipeline even if the name already exists

Import the pipeline from a file

Step(StepCLI)

Step creation, dependency, output commands

Trait Implementations

impl Clone for PipelineSubCommand

fn clone(&self) -> PipelineSubCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for PipelineSubCommand

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for PipelineSubCommand

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

Formats the value using the given formatter.

impl FromArgMatches for PipelineSubCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for PipelineSubCommand

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Subcommand for PipelineSubCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand