Skip to main content

CommandExecutor

Struct CommandExecutor 

Source
pub struct CommandExecutor { /* private fields */ }
Expand description

Command executor for running commands in shell sessions.

Implementations§

Source§

impl CommandExecutor

Source

pub fn new(store: Arc<SessionStore>) -> Self

Create a new command executor.

Source

pub fn execute_sync(&self, command: &Command) -> Result<ExecutionResult>

Execute a command synchronously (blocking).

This runs the command and waits for completion or timeout. Prefer CommandExecutor::execute from async contexts — this blocking variant must never be called directly on a tokio worker thread.

Source

pub async fn execute(&self, command: &Command) -> Result<ExecutionResult>

Execute a command, keeping the async runtime responsive.

The blocking work runs on a dedicated blocking thread via spawn_blocking, so the tokio worker pool (and therefore /health and the accept loop) is never starved by a slow or hung command. The underlying [run_command] enforces its own timeout, so this always completes without leaking runtime capacity.

Source

pub async fn execute_async( &self, command: &Command, ) -> Result<(Receiver<OutputChunk>, JoinHandle<Result<ExecutionResult>>)>

Execute a command asynchronously, streaming output chunks as they arrive.

Returns a receiver that yields OutputChunks live, plus a join handle resolving to the final ExecutionResult. Backed by the same piped [run_command_streaming] core as the non-streaming paths, so it inherits real completion detection, enforceable timeout, and process-tree kill — none of which the previous PTY implementation could provide for non-interactive commands (see [run_command_streaming]).

A consumer that stops receiving should drop the receiver. Holding it while awaiting the join handle is a deadlock in waiting: the channel is bounded, and the producer runs inside the control loop that enforces the timeout, so a full channel stops that loop from checking anything. Both WebSocket handlers used to do exactly this when their client hung up, and the command then outlived its own timeout — verified by watching a child with a five-second timeout run to completion.

Dropping the receiver frees the producer immediately. As a backstop for the consumer that forgets, forwarding gives up once the command’s own deadline has passed — timeout enforcement is a guarantee of this crate, not something each consumer re-earns.

Source

pub async fn execute_in_session( &self, session_id: &SessionId, command: &Command, ) -> Result<ExecutionResult>

Execute a command in an existing session.

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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> 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