Struct Settings 

pub struct Settings {
    pub permissions: PermissionSet,
    pub env: Option<HashMap<String, String>>,
    pub model: Option<String>,
    pub hooks: Option<Hooks>,
    pub sandbox: Option<Sandbox>,
    pub attribution: Option<Attribution>,
    pub enabled_plugins: Option<HashMap<String, bool>>,
    pub cleanup_period_days: Option<u32>,
    pub language: Option<String>,
    pub bypass_permissions: Option<bool>,
    pub extra: HashMap<String, Value>,
}

The main settings structure for Claude Code.

This represents the full schema of a Claude Code settings file, supporting all configuration options available at user and project levels.

Fields

permissions: PermissionSet

Tool permission configuration controlling what Claude Code can access.

env: Option<HashMap<String, String>>

Environment variables to set for tool execution.

model: Option<String>

Override the default Claude model.

hooks: Option<Hooks>

Hook configurations for pre/post tool execution.

sandbox: Option<Sandbox>

Sandbox configuration for command execution.

attribution: Option<Attribution>

Attribution settings for git commits and PRs.

enabled_plugins: Option<HashMap<String, bool>>

Map of enabled plugins.

cleanup_period_days: Option<u32>

Number of days before session cleanup (default: 30).

language: Option<String>

Preferred response language.

bypass_permissions: Option<bool>

When true, Claude Code starts with permissions bypassed (equivalent to --dangerously-skip-permissions). Useful when an external tool like Clash is the sole permission handler.

extra: HashMap<String, Value>

Any additional fields not explicitly defined.

Implementations

impl Settings

pub fn new() -> Self

Creates a new empty Settings instance.

pub fn with_permissions(self, permissions: PermissionSet) -> Self

Creates a Settings instance with the specified permissions.

pub fn with_env(self, env: HashMap<String, String>) -> Self

Creates a Settings instance with the specified environment variables.

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

Creates a Settings instance with the specified model.

pub fn with_hooks(self, hooks: Hooks) -> Self

Creates a Settings instance with the specified hooks.

pub fn with_sandbox(self, sandbox: Sandbox) -> Self

Creates a Settings instance with the specified sandbox configuration.

pub fn with_attribution(self, attribution: Attribution) -> Self

Creates a Settings instance with the specified attribution.

pub fn with_bypass_permissions(self, enabled: bool) -> Self

Creates a Settings instance with bypass_permissions enabled or disabled.

pub fn is_empty(&self) -> bool

Returns true if all fields are None or empty.

pub fn is_clash_installed(&self) -> bool

Returns true if these settings were installed by clash.

This checks for the presence of the _clashInstalled marker field.

pub fn mark_clash_installed(&mut self)

Marks these settings as installed by clash.

This sets the _clashInstalled field to true.

pub fn clear_clash_installed(&mut self)

Clears the clash installation marker from these settings.

pub fn with_clash_installed(self) -> Self

Builder method to mark settings as clash-installed.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Settings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Settings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Merge for Settings

fn merge(&self, other: &Self) -> Self

Merges self with another value, preferring values from other (higher precedence).

impl PartialEq for Settings

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Settings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Settings