Skip to main content

SessionRequest

Struct SessionRequest 

Source
pub struct SessionRequest {
Show 18 fields pub model: Option<String>, pub provider: Option<String>, pub permission_mode: Option<PermissionMode>, pub system_prompt: Option<String>, pub append_system_prompt: Option<String>, pub tools: Option<Vec<String>>, pub include_tools: Option<Vec<String>>, pub exclude_tools: Option<Vec<String>>, pub cwd: Option<PathBuf>, pub effort: Option<Effort>, pub enable_auto_memory: Option<bool>, pub short_prompt: Option<bool>, pub no_skills: Option<bool>, pub include_skills: Option<Vec<String>>, pub exclude_skills: Option<Vec<String>>, pub save_session: Option<bool>, pub unattended: Option<bool>, pub title: Option<String>,
}
Expand description

The requested session configuration — the payload of Op::StartSession. A set field is pinned: it wins over every default. An unset field means “the host’s default for this, now”: the daemon fills it from the user’s settings (re-read at the session boundary) or its built-in default. There is exactly one meaning, regardless of who built the value — never “leave unchanged”.

Fields§

§model: Option<String>§provider: Option<String>§permission_mode: Option<PermissionMode>§system_prompt: Option<String>§append_system_prompt: Option<String>§tools: Option<Vec<String>>

Exactly these tools, replacing the default tool set as the base.

§include_tools: Option<Vec<String>>

Tools added on top of the base set (tools, or the default set).

§exclude_tools: Option<Vec<String>>

Tools removed from the session; wins over tools and include_tools.

§cwd: Option<PathBuf>§effort: Option<Effort>§enable_auto_memory: Option<bool>§short_prompt: Option<bool>§no_skills: Option<bool>

When true, the session loads no skills: none are discovered, advertised, or invocable.

§include_skills: Option<Vec<String>>

Skills added to the default set; names match exactly. Does not enable skill loading when disabled.

§exclude_skills: Option<Vec<String>>

Skills removed from the session; names match exactly. Wins over include_skills.

§save_session: Option<bool>

Whether the session writes a transcript and a resumable snapshot.

§unattended: Option<bool>

Whether no one can answer an approval prompt for this session. When true, a tool call that would pause the turn for approval is denied instead of pausing. Absent means false.

§title: Option<String>

A title for the session (see SessionUpdate::title for the rules).

Implementations§

Source§

impl SessionRequest

Source

pub fn patched(self, patch: SessionRequest) -> SessionRequest

Fold patch onto self, field by field: a set field in the patch wins, an unset one keeps self’s value. This is the rule for every request-over-request combination (e.g. a client retargeting the request it keeps for /clear). patch is destructured exhaustively (no .. rest) so adding a field fails to compile here until its fold rule is decided.

Trait Implementations§

Source§

impl Clone for SessionRequest

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 SessionRequest

Source§

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

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

impl Default for SessionRequest

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for SessionRequest

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 PartialEq for SessionRequest

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 SessionRequest

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 SessionRequest

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.