Enum Command 

#[non_exhaustive]
pub enum Command {
    JobList,
    JobShow,
    InstanceList,
    InstanceShow,
    ExecutionList,
    ExecutionShow,
    ExecutionSteps,
    ExecutionPartitions,
    ExecutionHistory,
    ExecutionStop,
    ExecutionRestart,
    ExecutionAbandon,
    ExecutionRecover,
    Launch,
    RetentionPlan,
    RetentionApply,
    RetentionHold,
    RetentionRelease,
    ConfigShow,
    SchemaStatus,
    DiagnosticsBundle,
}

One command of the closed oxide-batch <noun> <verb> grammar.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

JobList

List registered job names.

JobShow

Show one job’s definition identity.

InstanceList

List instances of a job.

InstanceShow

Show one instance.

ExecutionList

List executions of an instance, or age-bounded stale candidates.

ExecutionShow

Show one execution projection.

ExecutionSteps

List step executions.

ExecutionPartitions

List partitions of a partitioned step.

ExecutionHistory

List flow, recovery, and operator records.

ExecutionStop

Request a durable stop.

ExecutionRestart

Start a new attempt.

ExecutionAbandon

Make an execution permanently non-restartable.

ExecutionRecover

Propose and apply a recovery decision.

Launch

Launch a registered job.

RetentionPlan

Produce a bounded purge plan and digest.

RetentionApply

Apply a purge plan.

RetentionHold

Place a hold on an instance.

RetentionRelease

Release a hold.

ConfigShow

Print effective configuration with sources.

SchemaStatus

Report schema version and migration state.

DiagnosticsBundle

Write a bounded redacted incident bundle.

Implementations

impl Command

pub fn resolve(words: &[&str]) -> Option<Self>

Resolves one closed noun and verb.

launch is the single one-word command; every other command is a noun followed by a verb.

pub const fn as_str(self) -> &'static str

Returns the canonical space-separated command name.

pub const fn class(self) -> ActionClass

Returns the class a deployment authorizes before the command runs.

pub const fn is_mutating(self) -> bool

Returns whether the command can change durable state.

pub const fn supports_dry_run(self) -> bool

Returns whether --dry-run is accepted.

Dry run is offered only where a guard evaluation or a plan digest is worth reporting without a mutation.

pub const fn is_paginated(self) -> bool

Returns whether the command reads a bounded page of rows.

pub const fn needs_repository(self) -> bool

Returns whether the command needs an open repository connection.

pub const fn all() -> &'static [Self]

Returns every command in canonical order.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Command

impl Debug for Command

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

Formats the value using the given formatter.

impl Display for Command

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

Formats the value using the given formatter.

impl Eq for Command

impl Hash for Command

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Command

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Command

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