Struct SessionConfig 

pub struct SessionConfig {
    pub command: String,
    pub args: Vec<String>,
    pub env: HashMap<String, String>,
    pub inherit_env: bool,
    pub working_dir: Option<PathBuf>,
    pub dimensions: (u16, u16),
    pub timeout: TimeoutConfig,
    pub buffer: BufferConfig,
    pub logging: LoggingConfig,
    pub line_ending: LineEnding,
    pub encoding: EncodingConfig,
    pub delay_before_send: Duration,
}

Configuration for a session.

Fields

command: String

The command to execute.

args: Vec<String>

Command arguments.

env: HashMap<String, String>

Environment variables to set.

inherit_env: bool

Whether to inherit the parent environment.

working_dir: Option<PathBuf>

Working directory for the process.

dimensions: (u16, u16)

Terminal dimensions (width, height).

timeout: TimeoutConfig

Timeout configuration.

buffer: BufferConfig

Buffer configuration.

logging: LoggingConfig

Logging configuration.

line_ending: LineEnding

Line ending configuration.

encoding: EncodingConfig

Encoding configuration.

delay_before_send: Duration

Delay before send operations.

Implementations

impl SessionConfig

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

Create a new session configuration with the given command.

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

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

Set the command arguments.

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

Add an environment variable.

pub const fn inherit_env(self, inherit: bool) -> Self

Set whether to inherit the parent environment.

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

Set the working directory.

pub const fn dimensions(self, width: u16, height: u16) -> Self

Set the terminal dimensions.

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

Set the default timeout.

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

Set the line ending style.

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

Set the delay before send operations.

Trait Implementations

impl Clone for SessionConfig

fn clone(&self) -> SessionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionConfig

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

Formats the value using the given formatter.

impl Default for SessionConfig

fn default() -> Self

Returns the “default value” for a type.

impl From<&SessionConfig> for PtyConfig

fn from(config: &SessionConfig) -> Self

Converts to this type from the input type.

impl From<SessionBuilder> for SessionConfig

fn from(builder: SessionBuilder) -> Self

Converts to this type from the input type.