Struct WizardStep 

pub struct WizardStep { /* private fields */ }

One step of a flow, identified by what it is rather than where it sits.

Implementations

impl WizardStep

pub fn new(id: impl Into<SharedString>, title: impl Into<SharedString>) -> Self

pub fn description(self, description: impl Into<SharedString>) -> Self

pub fn status(self, status: StepStatus) -> Self

pub fn complete(self) -> Self

pub fn current(self) -> Self

pub fn upcoming(self) -> Self

pub fn blocked(self, reason: impl Into<SharedString>) -> Self

pub fn failed(self, reason: impl Into<SharedString>) -> Self

pub fn reachable(self, reachable: bool) -> Self

Whether the typist may jump straight to this step.

Left unsaid, a completed step may be revisited and every other step may not, because a step nobody has reached is not a place the flow can honestly offer.

pub fn id(&self) -> &SharedString

Trait Implementations

impl Clone for WizardStep

fn clone(&self) -> WizardStep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WizardStep

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

Formats the value using the given formatter.

impl Eq for WizardStep

impl PartialEq for WizardStep

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WizardStep