Struct EofGuard 

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

Input decorator that prevents premature exit on EOF

This is a decorator of Input that combines the behavior of the ignore-eof shell option with protection against accidental exit when there are suspended jobs.

On EOF (empty line), the decorator retries reading if any of the following conditions is met (provided the shell is interactive, the input is a terminal, and the retry limit has not been reached):

1. SuspendedJobsGuardConfig is present in env.any, the PosixlyCorrect option is off, and there are suspended jobs — prints SuspendedJobsGuardConfig::message.
2. The ignore-eof option is enabled and IgnoreEofConfig is present in env.any — prints IgnoreEofConfig::message.

The retry limit is 50 consecutive EOFs per next_line call. Once the limit is reached the empty string is returned, allowing the shell to exit.

If neither SuspendedJobsGuardConfig nor IgnoreEofConfig is present in env.any, the decorator passes through all input unchanged (no retries).

Unlike IgnoreEof, this decorator also checks for suspended jobs, so it should be used instead of IgnoreEof in the top-level interactive read loop.

Implementations

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

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

Creates a new EofGuard decorator.

The arguments match those of IgnoreEof::new except that there is no message argument — the messages are read from SuspendedJobsGuardConfig and IgnoreEofConfig stored in env.any.

inner is the wrapped input, fd is the terminal file descriptor to check, and env is the shared environment.

Trait Implementations

impl<S, T: Clone> Clone for EofGuard<'_, '_, 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 EofGuard<'a, 'b, S, T>

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

Formats the value using the given formatter.

impl<S: Isatty + WriteAll, T: Input> Input for EofGuard<'_, '_, S, T>

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

Reads a next line of the source code.