Struct roadmap::Step

pub struct Step { /* fields omitted */ }

A roadmap step.

See the crate documentation for an example. You probably don't want to create steps manually, but via the roadmap YAML parsing function.

Methods

impl Step

pub fn new(name: &str, label: &str) -> Step

Create a new step with a name and a label.

pub fn name(&self) -> &str

Return the name of a step.

pub fn label(&self) -> &str

Return the label of a step.

pub fn status(&self) -> Status

Return the status of a step.

pub fn set_status(&mut self, status: Status)

Set the status of a step.

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

Return vector of names of dependencies for a step.

pub fn add_dependency(&mut self, name: &str)

Add the name of a dependency to step. Steps are referred by name. Steps don't know about other steps, and can't validate that the dependency exists, so this always works.

pub fn depends_on(&self, other: &Step) -> bool

Does this step depend on given other step?

Trait Implementations

impl Clone for Step

fn clone(&self) -> Step

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Step

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

Formats the value using the given formatter.

impl Display for Step

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

Formats the value using the given formatter.

impl Eq for Step

impl PartialEq<Step> for Step

fn eq(&self, other: &Step) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Step) -> bool

This method tests for !=.

impl StructuralEq for Step

impl StructuralPartialEq for Step