Struct CommandGraph 

pub struct CommandGraph {
    pub schema: String,
    pub fingerprint: String,
    pub commands: Vec<CommandNode>,
    pub diagnostics: Vec<Diagnostic>,
}

The whole graph.

Fields

schema: String

The schema of this document.

fingerprint: String

A hash of the semantic content: the identity a cache and a generated projection key on. Nothing that varies between two runs over the same tree is in it.

commands: Vec<CommandNode>

Every command, in a deterministic order: origin, then path.

diagnostics: Vec<Diagnostic>

What the build found.

Implementations

impl CommandGraph

pub fn get(&self, id: &CommandId) -> Option<&CommandNode>

Look one up.

pub fn resolve(&self, surface: Surface, spelling: &str) -> Option<&CommandNode>

Resolve a surface’s spelling of a command back to the canonical node.

This is the one place a surface alias is interpreted. A completion for just resolves the recipe name here and then asks the same engine the command line asks, which is why there is no second completion implementation.

pub fn errors(&self) -> Vec<&Diagnostic>

The errors, if any. A projection refuses to write when this is not empty.

pub fn of_origin(&self, origin: Origin) -> impl Iterator<Item = &CommandNode>

The commands of one origin.

pub fn by_group(&self) -> BTreeMap<String, Vec<&CommandNode>>

The runnable commands, grouped by their group, in graph order.

Trait Implementations

impl Clone for CommandGraph

fn clone(&self) -> CommandGraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandGraph

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandGraph

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CommandGraph

impl JsonSchema for CommandGraph

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 PartialEq for CommandGraph

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

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 CommandGraph