Struct cucumber::writer::Basic

pub struct Basic { /* fields omitted */ }

Default Writer implementation outputting to Terminal (STDOUT by default).

Pretty-prints with colors if terminal was successfully detected, otherwise has simple output. Useful for running tests with CI tools.

Implementations

impl Basic

pub fn new() -> Self

Creates a new Basic Writer.

Methods from Deref<Target = Term>

pub fn style(&self) -> Style

Returns the style for the term

pub fn target(&self) -> TermTarget

Returns the target

pub fn write_line(&self, s: &str) -> Result<(), Error>

Writes a string to the terminal and adds a newline.

pub fn read_char(&self) -> Result<char, Error>

Read a single character from the terminal

This does not echo the character and blocks until a single character is entered.

pub fn read_key(&self) -> Result<Key, Error>

Read a single key form the terminal.

This does not echo anything. If the terminal is not user attended the return value will always be the unknown key.

pub fn read_line(&self) -> Result<String, Error>

Read one line of input.

This does not include the trailing newline. If the terminal is not user attended the return value will always be an empty string.

pub fn read_line_initial_text(&self, initial: &str) -> Result<String, Error>

Read one line of input with initial text.

This does not include the trailing newline. If the terminal is not user attended the return value will always be an empty string.

pub fn read_secure_line(&self) -> Result<String, Error>

Read securely a line of input.

This is similar to read_line but will not echo the output. This also switches the terminal into a different mode where not all characters might be accepted.

pub fn flush(&self) -> Result<(), Error>

Flushes internal buffers.

This forces the contents of the internal buffer to be written to the terminal. This is unnecessary for unbuffered terminals which will automatically flush.

pub fn is_term(&self) -> bool

Checks if the terminal is indeed a terminal.

pub fn features(&self) -> TermFeatures<'_>

Checks for common terminal features.

pub fn size(&self) -> (u16, u16)

Returns the terminal size in rows and columns or gets sensible defaults.

pub fn size_checked(&self) -> Option<(u16, u16)>

Returns the terminal size in rows and columns.

If the size cannot be reliably determined None is returned.

pub fn move_cursor_to(&self, x: usize, y: usize) -> Result<(), Error>

Moves the cursor to x and y

pub fn move_cursor_up(&self, n: usize) -> Result<(), Error>

Moves the cursor up n lines

pub fn move_cursor_down(&self, n: usize) -> Result<(), Error>

Moves the cursor down n lines

pub fn move_cursor_left(&self, n: usize) -> Result<(), Error>

Moves the cursor left n lines

pub fn move_cursor_right(&self, n: usize) -> Result<(), Error>

Moves the cursor down n lines

pub fn clear_line(&self) -> Result<(), Error>

Clears the current line.

The positions the cursor at the beginning of the line again.

pub fn clear_last_lines(&self, n: usize) -> Result<(), Error>

Clear the last n lines.

This positions the cursor at the beginning of the first line that was cleared.

pub fn clear_screen(&self) -> Result<(), Error>

Clears the entire screen.

pub fn clear_to_end_of_screen(&self) -> Result<(), Error>

Clears the entire screen.

pub fn clear_chars(&self, n: usize) -> Result<(), Error>

Clears the last char in the the current line.

pub fn set_title<T>(&self, title: T) where
    T: Display, 

Set the terminal title

pub fn show_cursor(&self) -> Result<(), Error>

Makes cursor visible again

pub fn hide_cursor(&self) -> Result<(), Error>

Hides cursor

Trait Implementations

impl<'val, W, Val> Arbitrary<'val, W, Val> for Basic where
    W: World + Debug,
    Val: AsRef<str> + 'val, 

fn write<'life0, 'async_trait>(
    &'life0 mut self,
    val: Val
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait>> where
    'val: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Writes val to the Writer’s output.

impl Debug for Basic

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

Formats the value using the given formatter.

impl Default for Basic

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Basic

type Target = Term

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<W: World + Debug> Writer<W> for Basic

type Cli = Cli

CLI options of this Writer. In case no options should be introduced, just use cli::Empty.

fn handle_event<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    ev: Result<Event<Cucumber<W>>>,
    cli: &'life1 Self::Cli
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Handles the given Cucumber event.