Skip to main content

SpecGraph

Struct SpecGraph 

Source
pub struct SpecGraph { /* private fields */ }
Expand description

A directed graph of spec files, built from requires: references.

Resolves cross-file dependencies at construction time, rejects cycles, and provides topological ordering for downstream execution.

Implementations§

Source§

impl SpecGraph

Source

pub fn from_roots(roots: &[PathBuf]) -> Result<Self, Vec<ParseError>>

Discover and parse every .ought.md file under the given roots using the default OughtMdParser, then build the graph.

Source

pub fn from_roots_with( parser: &dyn Parser, roots: &[PathBuf], ) -> Result<Self, Vec<ParseError>>

Same as SpecGraph::from_roots but parses with a caller-supplied Parser. Useful for tests and for plugging in alternative spec formats.

Source

pub fn from_specs(specs: Vec<Spec>) -> Result<Self, Vec<ParseError>>

Build a graph from already-parsed specs. Validates that every requires: entry resolves to a spec in the set and rejects cycles.

Prefer this when callers have their own parsing pipeline (tests, the viewer, any consumer that wants to inspect or transform specs before graph construction).

Source

pub fn specs(&self) -> &[Spec]

All parsed specs.

Source

pub fn topological_order(&self) -> Vec<&Spec>

Specs in topological order (dependencies before dependents). Uses Kahn’s algorithm over the pre-resolved edges.

Source

pub fn get_by_path(&self, path: &Path) -> Option<&Spec>

Look up a spec by its source file path.

Trait Implementations§

Source§

impl Debug for SpecGraph

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.