Skip to main content

PromptRunParams

Struct PromptRunParams 

Source
pub struct PromptRunParams {
    pub cwd: String,
    pub prompt: String,
    pub model: Option<String>,
    pub effort: Option<ReasoningEffort>,
    pub approval_policy: ApprovalPolicy,
    pub sandbox_policy: SandboxPolicy,
    pub privileged_escalation_approved: bool,
    pub attachments: Vec<PromptAttachment>,
    pub timeout: Duration,
    pub output_schema: Option<Value>,
}

Fields§

§cwd: String§prompt: String§model: Option<String>§effort: Option<ReasoningEffort>§approval_policy: ApprovalPolicy§sandbox_policy: SandboxPolicy§privileged_escalation_approved: bool

Explicit opt-in gate for privileged sandbox usage (SEC-004). Default stays false to preserve safe-by-default posture.

§attachments: Vec<PromptAttachment>§timeout: Duration§output_schema: Option<Value>

Implementations§

Source§

impl PromptRunParams

Source

pub fn new(cwd: impl Into<String>, prompt: impl Into<String>) -> Self

Create prompt-run params with safe defaults. Allocation: two String allocations for cwd/prompt. Complexity: O(n), n = input lengths.

Source

pub fn with_model(self, model: impl Into<String>) -> Self

Set explicit model override. Allocation: one String. Complexity: O(model length).

Source

pub fn with_effort(self, effort: ReasoningEffort) -> Self

Set explicit reasoning effort. Allocation: none. Complexity: O(1).

Source

pub fn with_approval_policy(self, approval_policy: ApprovalPolicy) -> Self

Set approval policy override. Allocation: none. Complexity: O(1).

Source

pub fn with_sandbox_policy(self, sandbox_policy: SandboxPolicy) -> Self

Set sandbox policy override. Allocation: depends on sandbox payload move/clone at callsite. Complexity: O(1).

Source

pub fn allow_privileged_escalation(self) -> Self

Explicitly approve privileged sandbox escalation for this run. Callers are expected to set approval policy + scope alongside this flag.

Source

pub fn with_timeout(self, timeout: Duration) -> Self

Set prompt timeout. Allocation: none. Complexity: O(1).

Source

pub fn with_output_schema(self, output_schema: Value) -> Self

Set one optional JSON Schema for the final assistant message.

Source

pub fn with_attachment(self, attachment: PromptAttachment) -> Self

Add one generic attachment. Allocation: amortized O(1) push. Complexity: O(1).

Source

pub fn attach_path(self, path: impl Into<String>) -> Self

Add one @path attachment. Allocation: one String. Complexity: O(path length).

Source

pub fn attach_path_with_placeholder( self, path: impl Into<String>, placeholder: impl Into<String>, ) -> Self

Add one @path attachment with placeholder. Allocation: two Strings. Complexity: O(path + placeholder length).

Source

pub fn attach_image_url(self, url: impl Into<String>) -> Self

Add one remote image attachment. Allocation: one String. Complexity: O(url length).

Source

pub fn attach_local_image(self, path: impl Into<String>) -> Self

Add one local image attachment. Allocation: one String. Complexity: O(path length).

Source

pub fn attach_skill( self, name: impl Into<String>, path: impl Into<String>, ) -> Self

Add one skill attachment. Allocation: two Strings. Complexity: O(name + path length).

Trait Implementations§

Source§

impl Clone for PromptRunParams

Source§

fn clone(&self) -> PromptRunParams

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PromptRunParams

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for PromptRunParams

Source§

fn eq(&self, other: &PromptRunParams) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PromptRunParams

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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