Skip to main content

SessionConfig

Struct SessionConfig 

Source
pub struct SessionConfig {
Show 19 fields pub session_id: Option<String>, pub model: Option<String>, pub reasoning_effort: Option<ReasoningEffort>, pub config_dir: Option<String>, pub tools: Option<Vec<ToolDefinition>>, pub system_message: Option<SystemMessageConfig>, pub available_tools: Option<Vec<String>>, pub excluded_tools: Option<Vec<String>>, pub provider: Option<ProviderConfig>, pub working_directory: Option<String>, pub streaming: Option<bool>, pub mcp_servers: Option<HashMap<String, McpServerConfig>>, pub custom_agents: Option<Vec<CustomAgentConfig>>, pub skill_directories: Option<Vec<String>>, pub disabled_skills: Option<Vec<String>>, pub infinite_sessions: Option<InfiniteSessionConfig>, pub request_permission: Option<bool>, pub request_user_input: Option<bool>, pub hooks: Option<bool>,
}
Expand description

Configuration for creating a session.

This struct holds the parameters sent to the server via session.create. Tool handlers, permission handlers, user input handlers, and hooks are registered separately on the Rust side and are not serialized.

Fields§

§session_id: Option<String>§model: Option<String>§reasoning_effort: Option<ReasoningEffort>§config_dir: Option<String>§tools: Option<Vec<ToolDefinition>>§system_message: Option<SystemMessageConfig>§available_tools: Option<Vec<String>>§excluded_tools: Option<Vec<String>>§provider: Option<ProviderConfig>§working_directory: Option<String>§streaming: Option<bool>§mcp_servers: Option<HashMap<String, McpServerConfig>>§custom_agents: Option<Vec<CustomAgentConfig>>§skill_directories: Option<Vec<String>>§disabled_skills: Option<Vec<String>>§infinite_sessions: Option<InfiniteSessionConfig>§request_permission: Option<bool>

Set by the SDK based on whether handlers are registered (not user-set).

§request_user_input: Option<bool>

Set by the SDK based on whether handlers are registered (not user-set).

§hooks: Option<bool>

Set by the SDK based on whether hooks are registered (not user-set).

Trait Implementations§

Source§

impl Clone for SessionConfig

Source§

fn clone(&self) -> SessionConfig

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 SessionConfig

Source§

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

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

impl Default for SessionConfig

Source§

fn default() -> SessionConfig

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

impl<'de> Deserialize<'de> for SessionConfig

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 Serialize for SessionConfig

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

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,