Skip to main content

TurnStartParams

Struct TurnStartParams 

Source
pub struct TurnStartParams {
    pub session_id: String,
    pub command_id: String,
    pub input: Vec<TurnInputPart>,
    pub if_busy: Option<IfBusy>,
    pub display_text: Option<String>,
    pub reasoning_effort: Option<ReasoningEffort>,
    pub token_budget: Option<u64>,
    pub workspace_roots: Option<Vec<String>>,
    pub user_shell: Option<TurnUserShell>,
}
Expand description

turn/start params.

turn/start.providerRequestOptions is deliberately absent: RULED to stay off the published schema. The schema is the contract, and a free-form-object node kind is revisited only if the experimental field graduates.

Fields§

§session_id: String

The target session.

§command_id: String

The idempotency handle (UUIDv7). The fresh turn’s turnId derives from it.

§input: Vec<TurnInputPart>

Ordered content parts; required and non-empty.

§if_busy: Option<IfBusy>

Disposition when a turn is already running; default queue.

§display_text: Option<String>

Presentation form of the prompt for transcripts. Durable; carried on the resulting user-message view item. Never model-visible.

§reasoning_effort: Option<ReasoningEffort>

Reasoning tier sampled at submission for this turn.

§token_budget: Option<u64>

This turn’s token budget in tokens: an integer floor of 1, riding to workflow-launch admission and inert when no workflow launches. Omitted means no budget; 0 or a non-integer is invalid params, as is explicit null. No wire upper bound beyond the integer type. Experimental: the governing rules rules names and shape only, v1 membership stays open, so the member ships off the stable bundle until a v1 ruling graduates it.

§workspace_roots: Option<Vec<String>>

A sticky REPLACEMENT of the session’s runtime workspace-root set, binding at this turn’s launch and persisting for subsequent turns until replaced again — unlike reasoningEffort, which is this-turn-only. Same shape and validation as session/start.workspaceRoots; invalid params on an explicit ifBusy: "steer" submit and so is explicit null; omitted means “unchanged”, never “reset”.

§user_shell: Option<TurnUserShell>

A queued ! shell action riding this turn: the !cmd typed while a turn runs, executed at the next model-call boundary before any later steer. Exclusive with text and skill input; input may be empty only when this member is present. Capability-gated on userShell: a carrying turn on a connection without the grant fails -32010 capabilityRequired. Explicit null is invalid params (the null-tolerant set is closed). A v1 stable member.

Trait Implementations§

Source§

impl Clone for TurnStartParams

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TurnStartParams

Source§

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

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

impl<'de> Deserialize<'de> for TurnStartParams

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for TurnStartParams

Source§

impl PartialEq for TurnStartParams

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for TurnStartParams

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for TurnStartParams

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.