Struct StdinInputProvider 

pub struct StdinInputProvider<ReadTy: ReadProvider> { /* private fields */ }

An input provider which reads input from ‘STDIN’, or standard in.

Implementations

impl StdinInputProvider<Stdin>

pub fn new(app_name: &'static str) -> Result<Self, LisaError>

Create a new standard input provider.

Errors

Will error if the user has specified remappings that can’t happen (as determined by the environment variable ${APP_NAME}_STTY_REPLACEMENTS).

Additionally only error on Windows OS machines, when we fail to load in the library for ReadConsoleEx and various other functions that are necessary.

These should always be present in the kernel library.

impl<ReadTy: ReadProvider> StdinInputProvider<ReadTy>

pub fn new_with_provider( app_name: &'static str, provider: ReadTy, ) -> Result<Self, LisaError>

Create a new STDIN Input provider given an explicit read provider.

Errors

Will error if the user has specified remappings that can’t happen (as determined by the environment variable ${APP_NAME}_STTY_REPLACEMENTS).

Additionally only error on Windows OS machines, when we fail to load in the library for ReadConsoleEx and various other functions that are necessary.

These should always be present in the kernel library.

pub fn manually_poll_input_and_consume(&self) -> Result<String, LisaError>

Manually poll the STDIN input without anything else.

NOTE: THIS WILL CONSUME THE INPUT AND WILL NOT PASS IT ON TO THE NORMAL HANDLING ROUTINES. IT WOULD BE YOUR JOB TO HANDLE THIS INPUT.

Errors

If there is an OS error reading from standard in.

pub fn set_newline_hook( &mut self, hook: Box<dyn Fn(&str) -> bool + Send + Sync>, )

Set the newline hook.

A newline hook tells us if we should actually ‘complete’ the input. If this function returns true the newline is assumed to be marked as ‘completed’, if false input is still continuing.

Trait Implementations

impl<ReadTy: ReadProvider> Drop for StdinInputProvider<ReadTy>

fn drop(&mut self)

Executes the destructor for this type.

impl<ReadTy: ReadProvider> InputProvider for StdinInputProvider<ReadTy>

fn set_history_provider(&mut self, history: Box<dyn HistoryProvider>)

Set the current history provider to show previous commands.

fn is_stdin(&self) -> bool

If this input is coming from STDIN, and as such an input display should be rendered.

fn is_active(&self) -> bool

If the input provider is active, and accepting input.

fn set_active(&mut self, active: bool) -> Result<(), LisaError>

Set this terminal as ‘active’.

fn input_in_progress(&self) -> bool

If this provider has some active input, and someone is actively ‘typing’.

fn current_input(&self) -> String

Get any current input that has been provided.

fn poll_for_input(&mut self, ansi_supported: bool) -> Vec<TerminalInputEvent>

Poll for any active input events.

fn set_autocomplete_provider( &mut self, autocomplete: Box<dyn AutocompleteProvider>, )

Set the current autocomplete provider for this input provider.

fn current_autocomplete_suggestion(&self) -> Option<String>

Get the current autocomplete suggestion.

fn autocomplete_suggestion_pending(&self) -> bool

If an autocomplete suggestion is pending, but not yet completed.

fn current_history_search_value(&self) -> Option<String>

Get the current history search value that is being found.

fn is_doing_history_search(&self) -> bool

fn inputs(&mut self) -> Vec<String>

Get any fully complete inputs that have occured since things last ran.