[−][src]Struct roadmap::Roadmap
Represent a full project roadmap.
This stores all the steps needed to reach the end goal. See the crate leve documentation for an example.
Methods
impl Roadmap
[src]
pub fn new() -> Roadmap
[src]
Create a new, empty roadmap.
You probably want the from_yaml
function instead.
pub fn count_goals(&self) -> usize
[src]
Count number of steps that nothing depends on.
pub fn step_names(&self) -> impl Iterator<Item = &str>
[src]
Iterate over step names.
pub fn get_step(&self, name: &str) -> Option<&Step>
[src]
Get a step, given its name.
pub fn add_step(&mut self, step: Step)
[src]
Add a step to the roadmap.
pub fn iter(&self) -> impl Iterator<Item = &Step>
[src]
pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Step>
[src]
pub fn set_missing_statuses(&mut self)
[src]
Compute status of any step for which it has not been specified in the input.
pub fn is_ready(&self, step: &Step) -> bool
[src]
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
[src]
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
[src]
Should status be goal? In other words, does any other step depend on this one?
pub fn validate(&self) -> RoadmapResult<()>
[src]
pub fn format_as_dot(&self, label_width: usize) -> RoadmapResult<String>
[src]
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
Auto Trait Implementations
impl Send for Roadmap
impl Unpin for Roadmap
impl Sync for Roadmap
impl RefUnwindSafe for Roadmap
impl UnwindSafe for Roadmap
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,