Trait Dialog

Source

pub trait Dialog: Sized {
    type Update;
    type Output;

    // Required methods
    fn update_for_event(event: Event) -> Option<Self::Update>;
    fn perform_update(&mut self, update: Self::Update) -> Result<()>;
    fn state(&self) -> DialogState;
    fn output(self) -> Self::Output;
    fn viewport(&self) -> Viewport;
    fn draw(&mut self, frame: &mut Frame<'_>);

    // Provided methods
    fn run(self) -> Result<Self::Output> { ... }
    fn tick(&mut self) -> bool { ... }
    fn tick_rate(&self) -> Duration { ... }
    fn timeout(&self) -> Option<Duration> { ... }
}

Required Associated Types§

Source

type Update

Source

type Output

Required Methods§

Source

fn draw(&mut self, frame: &mut Frame<'_>)

Provided Methods§

Source

fn run(self) -> Result<Self::Output>

Examples found in repository ?

examples/input.rs (line 8)

fn main() -> anyhow::Result<()> {
    InputDialog::default()
        .with_prompt(Prompt::inline("Enter some text :) "))
        .run()?;
    Ok(())
}

More examples

Hide additional examples

examples/select.rs (line 5)

fn main() -> anyhow::Result<()> {
    let result = SelectDialog::new(vec!["one".into(), "two".into(), "three".into()]).run()?;
    println!("{}", result.unwrap_or("<none>".into()));
    Ok(())
}

examples/yes_no.rs (line 5)

fn main() -> anyhow::Result<()> {
    let result = YesNoDialog::default().with_message("Yes or no?").run()?;
    let display = if result { "yes" } else { "no" };
    println!("You chose: {display}");
    Ok(())
}