Struct roadmap::Roadmap

pub struct Roadmap { /* private fields */ }

Represent a full project roadmap.

This stores all the steps needed to reach the end goal. See the crate leve documentation for an example.

Implementations

impl Roadmap

pub fn new(map: HashMap<String, Step>) -> Self

Create a new, empty roadmap.

You probably want the from_yaml function instead.

pub fn count_goals(&self) -> usize

Count number of steps that nothing depends on.

pub fn step_names(&self) -> impl Iterator<Item = &str>

Iterate over step names.

pub fn get_step(&self, name: &str) -> Option<&Step>

Get a step, given its name.

pub fn add_step(&mut self, step: Step)

Add a step to the roadmap.

pub fn iter(&self) -> impl Iterator<Item = &Step>

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Step>

pub fn set_missing_statuses(&mut self)

Compute status of any step for which it has not been specified in the input.

pub fn is_ready(&self, step: &Step) -> bool

Should unset status be ready? In other words, if there are any dependencies, they are all finished.

pub fn is_blocked(&self, step: &Step) -> bool

Should unset status be blocked? In other words, if there are any dependencies, that aren’t finished.

pub fn is_goal(&self, step: &Step) -> bool

Should status be goal? In other words, does any other step depend on this one?

pub fn validate(&self) -> RoadmapResult<()>

pub fn format_as_dot(&self, label_width: usize) -> RoadmapResult<String>

Get a Graphviz dot language representation of a roadmap. This is the textual representation, and the caller needs to use the Graphviz dot(1) tool to create an image from it.

Trait Implementations

impl Clone for Roadmap

fn clone(&self) -> Roadmap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Roadmap

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

Formats the value using the given formatter.

impl Default for Roadmap

fn default() -> Roadmap

Returns the “default value” for a type.