Struct SessionBuilder 

pub struct SessionBuilder { /* private fields */ }

Builder for creating session configurations.

Implementations

impl SessionBuilder

pub fn new() -> Self

Create a new session builder with default configuration.

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

Set the command to execute.

pub fn args<I, S>(self, args: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set the command arguments.

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

Add a single argument.

pub fn envs<I, K, V>(self, envs: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Set environment variables.

pub fn env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set a single environment variable.

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

Set the working directory.

pub const fn dimensions(self, cols: u16, rows: u16) -> Self

Set the terminal dimensions (width, height).

pub const fn timeout(self, timeout: Duration) -> Self

Set the default timeout.

pub const fn timeout_config(self, config: TimeoutConfig) -> Self

Set the timeout configuration.

pub const fn buffer_max_size(self, max_size: usize) -> Self

Set the buffer max size.

pub const fn buffer_config(self, config: BufferConfig) -> Self

Set the buffer configuration.

pub const fn line_ending(self, line_ending: LineEnding) -> Self

Set the line ending style.

pub const fn unix_line_endings(self) -> Self

Use Unix line endings (LF).

pub const fn windows_line_endings(self) -> Self

Use the Windows line ending for sending: CR.

This is deliberately Cr and not CrLf. Like its unix_line_endings sibling — which sets Lf, the Unix ENTER — this selects the terminator the platform’s terminal sends for the ENTER key, not the platform’s text-file convention. \r is what Windows Terminal sends to ConPTY for ENTER.

CrLf also submits a line today, but only because conhost swallows the trailing LF; against a child with ENABLE_LINE_INPUT disabled an LF that did arrive would submit a second ENTER. To normalize text to CRLF, use LineEndingStyle instead — that is a separate concern from the send terminator.

pub const fn encoding(self, config: EncodingConfig) -> Self

Set the encoding configuration.

pub fn logging(self, config: LoggingConfig) -> Self

Set the logging configuration.

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

Enable logging to a file.

pub fn build(self) -> SessionConfig

Build the session configuration.

Trait Implementations

impl Clone for SessionBuilder

fn clone(&self) -> SessionBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionBuilder

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

Formats the value using the given formatter.

impl Default for SessionBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<SessionBuilder> for SessionConfig

fn from(builder: SessionBuilder) -> Self

Converts to this type from the input type.