Skip to main content

SettingsLoader

Struct SettingsLoader 

Source
pub struct SettingsLoader { /* private fields */ }
Expand description

Builder/loader for the settings layers.

Defaults to reading from ~/.claude/. If Self::project_root is set, also reads from <project_root>/.claude/. Missing files are not errors – the corresponding Settings field stays None.

Implementations§

Source§

impl SettingsLoader

Source

pub fn home() -> Result<Self>

Construct with the default user root ~/.claude/ and no project root. Add a project root with Self::project_root.

Source

pub fn at(user_root: impl Into<PathBuf>, project_root: Option<PathBuf>) -> Self

Construct with explicit roots. Useful for tests (point both at tempdirs) and non-default installs. project_root may be None if no project context applies.

Source

pub fn project_root(self, dir: impl Into<PathBuf>) -> Self

Set or override the project root. Note this is the .claude parent – i.e. the project directory itself, not <project>/.claude. The loader appends /.claude internally.

Source

pub fn user_root_path(&self) -> &Path

The configured user root (typically ~/.claude).

Source

pub fn project_root_path(&self) -> Option<&Path>

The configured project root, if any.

Source

pub fn load(&self) -> Result<Settings>

Read all four layers. Missing files become None; malformed JSON files raise an error so callers don’t silently lose data.

Trait Implementations§

Source§

impl Clone for SettingsLoader

Source§

fn clone(&self) -> SettingsLoader

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 SettingsLoader

Source§

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

Formats the value using the given formatter. 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