Skip to main content

Wizard

Struct Wizard 

Source
pub struct Wizard<'a, S> { /* private fields */ }
Expand description

A multi-step wizard with clickable breadcrumb navigation

§Example

use demand::{Wizard, Section, Navigation, Input};

#[derive(Default)]
struct State {
    name: String,
    email: String,
}

let result = Wizard::new("Setup")
    .section("Name", |state: &mut State, theme| {
        let name = Input::new("Your name")
            .theme(theme)
            .run()?;
        state.name = name;
        Ok(Navigation::Next)
    })
    .section("Email", |state: &mut State, theme| {
        let email = Input::new("Your email")
            .theme(theme)
            .run()?;
        state.email = email;
        Ok(Navigation::Next)
    })
    .section("Done", |_state, _theme| {
        Ok(Navigation::Done)
    })
    .run(&mut State::default())?;

Implementations§

Source§

impl<'a, S> Wizard<'a, S>

Source

pub fn new<T: Into<String>>(title: T) -> Self

Create a new wizard with the given title

Source

pub fn section<L, F>(self, label: L, run: F) -> Self
where L: Into<String>, F: Fn(&mut S, &Theme) -> Result<Navigation> + 'a,

Add a section to the wizard

Source

pub fn theme(self, theme: &'a Theme) -> Self

Set the theme for the wizard

Source

pub fn run(self, state: &mut S) -> Result<()>

Run the wizard with the given state

Returns the final state when Navigation::Done is received. Returns an error with io::ErrorKind::Interrupted if the user cancels.

Source

pub fn render_breadcrumb(&self) -> Result<String>

Render the breadcrumb navigation bar as a string.

This method is available for consumers who want to display the breadcrumb in custom UI layouts. Note that sections receive only (&mut S, &Theme) and don’t have direct access to the Wizard instance.

Returns the rendered breadcrumb as a string that can be printed.

Auto Trait Implementations§

§

impl<'a, S> Freeze for Wizard<'a, S>

§

impl<'a, S> !RefUnwindSafe for Wizard<'a, S>

§

impl<'a, S> !Send for Wizard<'a, S>

§

impl<'a, S> !Sync for Wizard<'a, S>

§

impl<'a, S> Unpin for Wizard<'a, S>

§

impl<'a, S> UnsafeUnpin for Wizard<'a, S>

§

impl<'a, S> !UnwindSafe for Wizard<'a, S>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.