Enum ValueSource 

pub enum ValueSource {
    Free,
    Enumerated,
    Path,
    RepositoryPath,
    Capability,
    Command,
    Rule,
    ObjectKind,
    Branch,
    Graph,
    Moment,
    Shell,
    Secret,
}

Where a value for an argument comes from, when something in this repository knows the set.

This is the completion contract, and it is a property of the argument, not of a shell script: the same source answers a shell’s TAB, a generated form’s select and a machine surface’s enumeration of what it will accept. Inference from the declaration comes first — a value-enum argument carries its own values, a PATH placeholder is a path — and only what cannot be inferred is annotated beside the command.

Variants

Free

Nothing here knows the set; the caller types a value.

Enumerated

The declaration carries the values; they are on the argument.

Path

A path in the filesystem.

RepositoryPath

A path inside the repository.

Capability

A capability id, from the registry.

Command

A command id, from this graph.

Rule

A rule id, from the effective rule set.

ObjectKind

An object kind, from the index.

Branch

A git branch in this repository.

Graph

A graph id, from the graph registry.

Moment

A moment id, from the why catalogue.

Shell

A shell name, from the shells the activation supports.

Secret

A secret. Never enumerated, never cached, never suggested.

Implementations

impl ValueSource

pub fn suggestible(self) -> bool

May a completion offer values for this source at all?

Trait Implementations

impl Clone for ValueSource

fn clone(&self) -> ValueSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ValueSource

impl Debug for ValueSource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ValueSource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ValueSource

impl JsonSchema for ValueSource

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for ValueSource

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ValueSource