Struct LocalTerminalOptions 

#[non_exhaustive]
pub struct LocalTerminalOptions { /* private fields */ }

Options for a local terminal with its own pty.

Implementations

impl LocalTerminalOptions

pub fn with_program( self, program: impl Into<PathBuf>, args: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Set the program and its arguments.

pub fn with_cwd(self, cwd: WorkingDirectory) -> Self

Set the working directory.

pub fn with_env(self, name: impl Into<String>, value: impl Into<String>) -> Self

Add an environment variable.

pub fn with_shell_integration(self, integration: ShellIntegration) -> Self

Set the shell integration.

pub fn with_engine(self, engine: EngineOptions) -> Self

Set the engine options.

pub fn with_login(self, login: bool) -> Self

Set whether the shell starts as a login shell.

pub fn with_input(self, input: impl Into<Vec<u8>>) -> Self

Set the bytes written right after the program starts.

pub fn without_env(self, name: impl Into<String>) -> Self

Remove an environment variable from the program’s environment.

pub fn with_shell_integration_features( self, features: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Set the shell integration features, as GHOSTTY_SHELL_FEATURES.

pub fn with_abnormal_exit_runtime(self, runtime: Duration) -> Self

Set the run time under which an exit is reported as abnormal.

pub fn engine(&self) -> &EngineOptions

The engine options.

pub fn program(&self) -> Option<&Path>

The program; None runs the user’s shell.

pub fn args(&self) -> &[String]

The program’s arguments.

pub fn cwd(&self) -> &WorkingDirectory

The working directory.

pub fn env(&self) -> &BTreeMap<String, String>

Extra environment variables.

pub fn env_remove(&self) -> &[String]

Environment variables removed from the program’s environment.

pub fn input(&self) -> &[u8]

The bytes written right after the program starts.

pub fn shell_integration(&self) -> ShellIntegration

The shell integration.

pub fn shell_integration_features(&self) -> &[String]

The shell integration features.

pub fn login(&self) -> bool

Whether the shell starts as a login shell.

pub fn abnormal_exit_runtime(&self) -> Duration

The run time under which an exit is reported as abnormal.

Trait Implementations

impl Clone for LocalTerminalOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LocalTerminalOptions

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

Formats the value using the given formatter.

impl Default for LocalTerminalOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for LocalTerminalOptions

impl PartialEq for LocalTerminalOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LocalTerminalOptions