Skip to main content

Runner

Struct Runner 

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

High-level async process runner with event-driven output handling.

Implementations§

Source§

impl Runner

Source

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

Create a new runner with command and arguments.

§Examples
use ej_io::runner::Runner;

let runner = Runner::new("ls", vec!["-la", "/tmp"]);
Source

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

Create a new runner with just a command (no arguments).

§Examples
use ej_io::runner::Runner;

let runner = Runner::new_without_args("pwd");
Source

pub fn get_full_command(&self) -> String

Get the full command string with arguments.

§Examples
use ej_io::runner::Runner;

let runner = Runner::new("ls", vec!["-la"]);
assert_eq!(runner.get_full_command(), "ls -la");
Source

pub async fn run( &self, tx: Sender<RunEvent>, should_stop: Arc<AtomicBool>, ) -> Option<ExitStatus>

Asynchronously run the process with event monitoring.

Starts the process and monitors its execution asynchronously, sending events via the provided tokio channel. Reads stdout and stderr concurrently until the process finishes or is stopped.

§Arguments
  • tx - Tokio async channel sender for RunEvent notifications
  • should_stop - Atomic flag to signal process termination
§Returns

Returns an Option<ExitStatus> - None if the process failed to start or was terminated, Some(ExitStatus) if the process completed normally.

§Examples
use ej_io::runner::{Runner, RunEvent};
use std::sync::{Arc, atomic::AtomicBool};
use tokio::sync::mpsc;

#[tokio::main]
async fn main() {
    let runner = Runner::new("echo", vec!["Hello"]);
    let (tx, mut rx) = mpsc::channel(100);
    let should_stop = Arc::new(AtomicBool::new(false));

    let exit_status = runner.run(tx, should_stop).await;
}

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