Struct toipe::Toipe

pub struct Toipe { /* private fields */ }

Typing test terminal UI and logic.

Implementations

impl<'a> Toipe

pub fn new(config: ToipeConfig) -> Result<Self>

Initializes a new typing test on the standard output.

See ToipeConfig for configuration options.

Initializes the word selector. Also invokes Toipe::restart().

pub fn restart(&mut self) -> Result<()>

Make the terminal ready for the next typing test.

Clears the screen, generates new words and displays them on the UI.

pub fn test(&mut self, stdin: StdinLock<'a>) -> Result<(bool, ToipeResults)>

Start typing test by monitoring input keys.

Must only be invoked after Toipe::restart().

If the test completes successfully, returns a boolean indicating whether the user wants to do another test and the ToipeResults for this test.