Struct menu::Runner

pub struct Runner<'a, I, T>
where
    I: Write,
{
    pub interface: I,
    /* private fields */
}

This structure handles the menu. You feed it bytes as they are read from the console and it executes menu actions when commands are typed in (followed by Enter).

Fields

interface: I

Implementations

impl<'a, I, T> Runner<'a, I, T>

where I: Write,

pub fn new( menu: Menu<'a, I, T>, buffer: &'a mut [u8], interface: I, context: &mut T ) -> Self

Create a new Runner. You need to supply a top-level menu, and a buffer that the Runner can use. Feel free to pass anything as the context type - the only requirement is that the Runner can write! to the context, which it will do for all text output.

pub fn prompt(&mut self, newline: bool)

Print out a new command prompt, including sub-menu names if applicable.

pub fn input_byte(&mut self, input: u8, context: &mut T)

Add a byte to the menu runner’s buffer. If this byte is a carriage-return, the buffer is scanned and the appropriate action performed. By default, an echo feature is enabled to display commands on the terminal.