Struct term_transcript::ShellOptions

pub struct ShellOptions<Ext = ()> { /* fields omitted */ }

Options for executing commands in the shell. Used in Transcript::from_inputs() and in TestConfig.

The type param maps to extensions available for the shell. For example, StdShell extension allows to specify custom aliases for the executed commands.

Implementations

impl<Ext> ShellOptions<Ext>

pub fn with_current_dir(self, current_dir: impl AsRef<Path>) -> Self

Changes the current directory of the command.

pub fn with_io_timeout(self, io_timeout: Duration) -> Self

Sets the I/O timeout for shell commands. This determines how long methods like Transcript::from_inputs() wait for output of a command before proceeding to the next command. Longer values allow to capture output more accurately, but result in longer execution.

pub fn with_init_command(self, command: impl Into<String>) -> Self

Adds an initialization command. Such commands are sent to the shell before executing any user input. The corresponding output from the shell is not captured.

pub fn with_line_mapper<F>(self, mapper: F) -> Self where
    F: FnMut(String) -> Option<String> + 'static, 

Sets the line mapper for the shell. This allows to filter and/or map terminal outputs.

pub fn with_cargo_path(self) -> Self

This is supported on Unix or Windows only.

Adds paths to cargo binaries (including examples) to the PATH env variable. This allows to call them by the corresponding filename, without specifying a path or doing complex preparations (e.g., calling cargo install).

Limitations

• The caller must be a unit or integration test; the method will work improperly otherwise.

impl ShellOptions<StdShell>

pub fn sh() -> Self

Creates options for an sh shell.

pub fn bash() -> Self

Creates options for a Bash shell.

pub fn powershell() -> Self

Creates options for PowerShell.

pub fn with_alias(self, name: &str, path_to_bin: &str) -> Self

Creates an alias for the binary at path_to_bin, which should be an absolute path. This allows to call the binary using this alias without complex preparations (such as installing it globally via cargo install), and is more flexible than Self::with_cargo_path().

In integration tests, you may use env!("CARGO_BIN_EXE_<name>") to get a path to binary targets.

Limitations

• For Bash and PowerShell, name must be a valid name of a function. For sh, name must be a valid name for the alias command. The name validity is not checked.

Trait Implementations

impl<Ext: Debug> Debug for ShellOptions<Ext>

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

Formats the value using the given formatter.

impl Default for ShellOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<Command> for ShellOptions

fn from(command: Command) -> Self

Performs the conversion.