Struct term_transcript::ShellOptions

source · [−]

pub struct ShellOptions<Cmd = Command> { /* private fields */ }

Expand description

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

source

impl ShellOptions<StdShell>

source

pub fn sh() -> Self

Creates options for an sh shell.

source

pub fn bash() -> Self

Creates options for a Bash shell.

source

pub fn powershell() -> Self

Creates options for PowerShell.

source

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.

source

impl<Cmd: ConfigureCommand> ShellOptions<Cmd>

source

pub fn new(command: Cmd) -> Self

Creates new options with the provided command.

source

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

Changes the current directory of the command.

source

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.

By default, the I/O timeout is 1 second.

source

pub fn with_init_timeout(self, init_timeout: Duration) -> Self

Sets an additional initialization timeout (relative to the one set by Self::with_io_timeout()) before reading the output of the first command.

By default, the initialization timeout is zero.

source

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.

source

pub fn with_env(self, name: impl AsRef<str>, value: impl AsRef<OsStr>) -> Self

Sets the value of an environment variable with the specified name.

source

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.

source

pub fn with_cargo_path(self) -> Self

Adds paths to cargo binaries (including examples) to the PATH env variable for the shell described by these options. 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.

source

pub fn with_additional_path(self, path: impl Into<PathBuf>) -> Self

Adds a specified path to the PATH env variable for the shell described by these options. This method can be called multiple times to add multiple paths and is composable with Self::with_cargo_path().