Skip to main content

BinaryExecutor

Struct BinaryExecutor 

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

Spawn the objectiveai cli binary on disk, feed it the argv from request.into_command(), and stream each stdout JSONL line back as either a typed T or a structured crate::cli::Error.

The binary is resolved at execute time (not at construction). Resolution order:

Implementations§

Source§

impl BinaryExecutor

Source

pub fn new(objectiveai_dir: Option<impl Into<PathBuf>>) -> Self

Source

pub fn from_path(binary: impl Into<PathBuf>) -> Self

Construct an executor that spawns the binary at binary directly, regardless of file name. Skips the objectiveai name lookup so tests can target a target/debug/objectiveai-cli build without renaming or symlinking.

Source

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

Set an environment variable on every child the executor spawns. Stacks on top of the parent’s env; intended for tests that need to pin a per-instance OBJECTIVEAI_DIR/OBJECTIVEAI_STATE or OBJECTIVEAI_ADDRESS without racing other parallel tests via std::env::set_var.

Source

pub fn kill_on_drop(self, on: bool) -> Self

When true, the spawned tokio::process::Child held in the stream state is sent a kill signal when the stream is dropped. Defaults to false. Wrappers that detect hangs (e.g. the cli-test HangPreventingBinaryCommandExecutor) toggle this on so dropping the inner stream tears the cli child down.

Source

pub fn detach(self, on: bool) -> Self

When true, the child is spawned detached from the parent’s console / process group so it survives parent exit. Pairs naturally with kill_on_drop = false (the default): drop the stream + exit the parent, the child keeps running orphaned.

  • Windows: sets DETACHED_PROCESS | CREATE_NEW_PROCESS_GROUP on the CreateProcessW call. DETACHED_PROCESS is what actually makes orphan survival work — without it the child inherits the parent’s console and receives CTRL_CLOSE_EVENT when the parent’s console window closes. The process-group flag is belt-and-suspenders signal isolation.
  • Unix: no-op. The kernel automatically re-parents the child to init when the parent exits.

Defaults to false.

Trait Implementations§

Source§

impl CommandExecutor for BinaryExecutor

Source§

type Error = Error

Source§

type Stream<T> = Pin<Box<dyn Stream<Item = Result<T, Error>> + Send>> where T: Send + 'static

Source§

async fn execute<R, T>( &self, request: R, agent_arguments: Option<&AgentArguments>, ) -> Result<Self::Stream<T>, Error>

Source§

async fn execute_one<R, T>( &self, request: R, agent_arguments: Option<&AgentArguments>, ) -> Result<T, Error>

Convenience for unary commands: run the request and resolve the first item from the stream. Implementations should error with their own “empty stream” variant if the stream closes without producing an item.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> ToAst for T

Source§

fn ast(self, begin: usize, end: usize) -> Spanned<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