Skip to main content

ExecSession

Struct ExecSession 

Source
pub struct ExecSession {
    pub id: SessionId,
    pub command: String,
    pub working_dir: String,
    pub started_at: Instant,
    pub timeout: Option<Duration>,
    pub status: SessionStatus,
    /* private fields */
}
Expand description

A background exec session.

Fields§

§id: SessionId

Session identifier.

§command: String

The command that was executed.

§working_dir: String

Working directory.

§started_at: Instant

When the session started.

§timeout: Option<Duration>

Timeout duration (if set).

§status: SessionStatus

Current status.

Implementations§

Source§

impl ExecSession

Source

pub fn new( command: String, working_dir: String, timeout: Option<Duration>, child: Child, ) -> Self

Create a new session for a running process.

Source

pub fn is_timed_out(&self) -> bool

Check if the process has exceeded its timeout.

Source

pub fn elapsed(&self) -> Duration

Get the elapsed time since the session started.

Source

pub fn append_output(&mut self, text: &str)

Append output to the combined buffer.

Source

pub fn poll_output(&mut self) -> &str

Get new output since the last poll.

Source

pub fn full_output(&self) -> &str

Get the full output log.

Source

pub fn log_output(&self, offset: Option<usize>, limit: Option<usize>) -> String

Get output with line-based offset and limit.

Source

pub fn try_read_output(&mut self) -> bool

Try to read any available output from the child process. Returns true if any output was read.

Uses platform-specific non-blocking I/O.

Source

pub fn check_exit(&mut self) -> bool

Check if the process has exited and update status.

Source

pub fn write_stdin(&mut self, data: &str) -> Result<(), String>

Write data to the process stdin.

Source

pub fn send_keys(&mut self, keys: &str) -> Result<usize, String>

Translate named keys to escape sequences and write them to stdin.

Supports key names: Enter, Tab, Escape, Space, Backspace, Up, Down, Left, Right, Home, End, PageUp, PageDown, Delete, Insert, Ctrl-A..Ctrl-Z, Ctrl-C, F1..F12, and plain text.

Multiple keys can be separated by spaces: "Enter", "Ctrl-C", "Up Up Down Down Left Right".

Source

pub fn kill(&mut self) -> Result<(), String>

Kill the process.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more