Skip to main content

DependencyGraph

Struct DependencyGraph 

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

A blocker edge points from the prerequisite to the issue waiting on it.

Implementations§

Source§

impl DependencyGraph

Source

pub fn from_issues(issues: &[(String, IssueHeading)]) -> Result<Self>

Build a graph and reject malformed duplicate IDs or cyclic dependencies.

§Errors

Returns an error if two headings share an id, an issue blocks itself, or the blocker edges form a cycle.

Source

pub fn from_headings<'a, I>(issues: I) -> Result<Self>
where I: IntoIterator<Item = &'a IssueHeading>,

Same graph as Self::from_issues, without copying headings.

§Errors

Returns an error if two headings share an id, an issue blocks itself, or the blocker edges form a cycle.

Source

pub fn accepts_edge(&self, blocker: &str, issue: &str) -> Result<(), Error>

Validate a prospective blocker insertion without mutating the graph.

Unknown ids are accepted: a missing endpoint is not a cycle.

§Errors

Returns an error if blocker is issue, or if adding the edge would close a loop.

Source

pub fn topological_ids(&self) -> Result<Vec<String>>

Return a deterministic prerequisite-first order.

§Errors

Returns an error if the graph contains a cycle.

Source

pub fn ancestors( &self, issue: &str, depth: usize, ) -> Result<Vec<(usize, String)>, Error>

Return nodes that transitively block issue, bounded by hop depth.

§Errors

Returns an error if issue is not in the graph.

Source

pub fn descendants( &self, issue: &str, depth: usize, ) -> Result<Vec<(usize, String)>, Error>

Return nodes transitively waiting on issue, bounded by hop depth.

§Errors

Returns an error if issue is not in the graph.

Trait Implementations§

Source§

impl Debug for DependencyGraph

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.