Skip to main content

CommonAgentState

Struct CommonAgentState 

Source
pub struct CommonAgentState {
    pub system_prompt: String,
    pub model: String,
    pub root: Option<String>,
    pub skip_permissions: bool,
    pub output_format: Option<String>,
    pub add_dirs: Vec<String>,
    pub capture_output: bool,
    pub sandbox: Option<SandboxConfig>,
    pub max_turns: Option<u32>,
    pub env_vars: Vec<(String, String)>,
}
Expand description

Shared configuration state for CLI-based agent providers.

Embed this struct in each provider to avoid duplicating field declarations and trivial setter implementations.

Fields§

§system_prompt: String§model: String§root: Option<String>§skip_permissions: bool§output_format: Option<String>§add_dirs: Vec<String>§capture_output: bool§sandbox: Option<SandboxConfig>§max_turns: Option<u32>§env_vars: Vec<(String, String)>

Implementations§

Source§

impl CommonAgentState

Source

pub fn new(default_model: &str) -> Self

Source

pub fn get_base_path(&self) -> &Path

Get the effective base path (root directory or “.”).

Source

pub fn make_command( &self, binary_name: &str, agent_args: Vec<String>, ) -> Command

Create a Command either directly or wrapped in sandbox.

Standard pattern used by Claude, Copilot, and Gemini. Sets current_dir, args, and env vars. Providers with custom sandbox behavior (Codex, Ollama) keep their own make_command().

Source

pub async fn run_interactive_command( cmd: &mut Command, agent_display_name: &str, ) -> Result<()>

Execute a command interactively (inheriting stdin/stdout/stderr).

Returns ProcessError on non-zero exit.

Source

pub async fn run_non_interactive_simple( &self, cmd: &mut Command, agent_display_name: &str, ) -> Result<Option<AgentOutput>>

Execute a non-interactive command with simple capture-or-passthrough.

If capture_output is set, captures stdout and returns Some(AgentOutput). Otherwise streams stdout to the terminal and returns None.

Used by Copilot, Gemini, Ollama. Providers with custom output parsing (Claude, Codex) keep their own non-interactive logic.

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