Struct IgnoreEof 

pub struct IgnoreEof<'a, 'b, S, T> { /* private fields */ }

Input decorator that ignores EOF on a terminal

This is a decorator of Input that adds the behavior of the ignore-eof shell option.

The decorator is effective only when all of the following conditions are met:

• The shell is interactive, that is, the Interactive option is enabled.
• The ignore-eof option is enabled.
• The input is a terminal.

The decorator reads from the inner input and usually returns the result as is. However, if the result is an empty string and the above conditions are met, the decorator will re-read the input until a non-empty string is obtained, an error occurs, or this process is repeated 20 times.

Implementations

impl<'a, 'b, S, T> IgnoreEof<'a, 'b, S, T>

pub fn new( inner: T, fd: Fd, env: &'a RefCell<&'b mut Env<S>>, message: String, ) -> Self

Creates a new IgnoreEof decorator.

The first argument is the inner Input that performs the actual input operation. The second argument is the file descriptor to be checked if it is a terminal. The third argument is the shell environment that contains the shell option state and the system interface to interact with the system. It is wrapped in a RefCell so that it can be shared with other decorators and the parser. The fourth argument is the text to be displayed when EOF is ignored.

The second argument fd should match the file descriptor that the inner input reads from. If the inner input reads from a different file descriptor, the IgnoreEof decorator may not detect the terminal correctly.

Trait Implementations

impl<S, T: Clone> Clone for IgnoreEof<'_, '_, S, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, 'b, S: Debug, T: Debug> Debug for IgnoreEof<'a, 'b, S, T>

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

Formats the value using the given formatter.

impl<S: Fcntl + Isatty + Write, T: Input> Input for IgnoreEof<'_, '_, S, T>

async fn next_line(&mut self, context: &Context) -> Result

Reads a next line of the source code.