Struct Terminal

pub struct Terminal {
    pub running: Arc<AtomicBool>,
    pub prompt: Arc<Mutex<String>>,
    pub term: Arc<Crossterm>,
    pub handler: Arc<dyn Cli>,
    pub terminate: Arc<AtomicBool>,
    pub pipe_raw: Channel<String>,
    pub pipe_crlf: Channel<String>,
    pub pipe_ctl: DuplexChannel,
    pub para_width: Arc<AtomicUsize>,
    /* private fields */
}

Terminal interface

Fields

running: Arc<AtomicBool>

prompt: Arc<Mutex<String>>

term: Arc<Crossterm>

handler: Arc<dyn Cli>

terminate: Arc<AtomicBool>

pipe_raw: Channel<String>

pipe_crlf: Channel<String>

pipe_ctl: DuplexChannel

para_width: Arc<AtomicUsize>

Implementations

impl Terminal

pub fn try_new(handler: Arc<dyn Cli>, prompt: &str) -> Result<Terminal, Error>

Create a new default terminal instance bound to the supplied command-line processor Cli.

pub fn try_new_with_options( handler: Arc<dyn Cli>, options: Options, ) -> Result<Terminal, Error>

Create a new terminal instance bound to the supplied command-line processor Cli. Receives options::Options that allow terminal customization.

pub async fn init(self: &Arc<Terminal>) -> Result<(), Error>

Init the terminal instance

pub fn inner( &self, ) -> Result<MutexGuard<'_, Inner>, PoisonError<MutexGuard<'_, Inner>>>

Access to the underlying terminal instance

pub fn history(&self) -> Vec<UnicodeString>

Get terminal command line history list as Vec<String>

pub fn reset_line_buffer(&self)

pub fn get_prompt(&self) -> String

Get the current terminal prompt string

pub fn prompt(&self)

Render the current prompt in the terminal

pub fn crlf(&self)

Output CRLF sequence

pub fn write<S>(&self, s: S)

where S: ToString,

Write a string

pub fn writeln<S>(&self, s: S)

where S: ToString,

Write a string ending with CRLF sequence

pub fn refresh_prompt(&self)

Refreshes the prompt and the user input buffer. This function is useful when the prompt is handled externally and contains data that should be updated.

pub fn para<S>(&self, text: S)

where S: Into<String>,

pub fn para_with_options<'a, S, Opt>(&self, width_or_options: Opt, text: S)

where S: Into<String>, Opt: Into<Options<'a>>,

pub fn help<S, H>( &self, list: &[(S, H)], separator: Option<&str>, ) -> Result<(), Error>

where S: ToString, H: ToString,

pub fn term(&self) -> Arc<Crossterm>

Get a clone of Arc of the underlying terminal instance

pub async fn run(self: &Arc<Terminal>) -> Result<(), Error>

Execute the async terminal processing loop. Once started, it should be stopped using Terminal::exit

pub async fn exit(self: &Arc<Terminal>)

Exits the async terminal processing loop (async fn)

pub fn abort(self: &Arc<Terminal>)

Exits the async terminal processing loop (sync fn)

pub async fn ask( self: &Arc<Terminal>, secret: bool, prompt: &str, ) -> Result<String, Error>

Ask a question (input a string until CRLF). secret argument suppresses echoing of the user input (useful for password entry)

pub async fn kbhit( self: &Arc<Terminal>, prompt: Option<&str>, ) -> Result<String, Error>

pub fn inject_unicode_string(&self, text: UnicodeString) -> Result<(), Error>

Inject a string into the current cursor position

pub fn inject<S>(&self, text: S) -> Result<(), Error>

where S: ToString,

pub fn inject_char(&self, ch: char) -> Result<(), Error>

pub fn is_running(&self) -> bool

Indicates that the terminal has received command input and has not yet returned from the processing. This flag is set to true when delivering the user command to the Cli handler and is reset to false when the Cli handler returns.

pub async fn exec<S>(self: &Arc<Terminal>, cmd: S) -> Result<(), Error>

where S: ToString,

pub fn set_theme(&self, _theme: Theme) -> Result<(), Error>

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

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

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

pub fn increase_font_size(&self) -> Result<Option<f64>, Error>

pub fn decrease_font_size(&self) -> Result<Option<f64>, Error>

pub fn set_font_size(&self, font_size: f64) -> Result<(), Error>

pub fn get_font_size(&self) -> Result<Option<f64>, Error>

pub fn cols(&self) -> Option<usize>

pub async fn select<T>( self: &Arc<Terminal>, prompt: &str, list: &[T], ) -> Result<Option<T>, Error>

where T: Display + Clone,

pub fn register_event_handler( self: &Arc<Terminal>, _handler: Arc<Box<dyn Fn(Event)>>, ) -> Result<(), Error>

pub fn register_link_matcher( &self, _regexp: &RegExp, _handler: Arc<Box<dyn Fn(Modifiers, &str)>>, ) -> Result<(), Error>

Trait Implementations

impl Clone for Terminal

fn clone(&self) -> Terminal

Returns a duplicate of the value.

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

Performs copy-assignment from source.