Skip to main content

RuntimeConfig

Struct RuntimeConfig 

Source
#[non_exhaustive]
pub struct RuntimeConfig { pub kindling_home: PathBuf, pub project_root: String, pub spool_path: Option<PathBuf>, pub spawn: SpawnStrategy, }
Expand description

Configuration for a Runtime.

#[non_exhaustive]: build via RuntimeConfig::embedded, RuntimeConfig::with_home, or RuntimeConfig::from_default_home (then mutate fields), so new fields can be added without a breaking change.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§kindling_home: PathBuf

Root of the per-project databases and the daemon’s socket/pid/port files (~/.kindling by default). Using the default layout shares the DB with the kindling CLI and Claude Code hooks.

§project_root: String

Project root string, sent as the X-Kindling-Project header on every data endpoint for per-project DB routing.

§spool_path: Option<PathBuf>

Path to the durable-emit spool file. Defaults to <home>/spool.ndjson when None. Only meaningful with the spool feature.

§spawn: SpawnStrategy

How to obtain the daemon. Defaults to SpawnStrategy::Embedded.

Implementations§

Source§

impl RuntimeConfig

Source

pub fn from_default_home( project_root: impl Into<String>, ) -> Result<Self, RuntimeError>

Build a config rooted at the default kindling home (~/.kindling) for project_root, with the default SpawnStrategy.

Errors only if no home directory can be determined.

Source

pub fn embedded(project_root: impl Into<String>) -> Self

Build an embedded-daemon config rooted at the default home for project_root (the common anvil case).

Infallible: if no home directory can be determined it silently falls back to .kindling in the current working directory. Prefer from_default_home when you want a missing home to surface as an error instead of a cwd-relative fallback.

Source

pub fn with_home( kindling_home: impl Into<PathBuf>, project_root: impl Into<String>, spawn: SpawnStrategy, ) -> Self

Build a config rooted at an explicit kindling_home (tests / isolated hosts) with the given SpawnStrategy.

Source

pub fn effective_spool_path(&self) -> PathBuf

The effective spool path: the configured one, or <home>/spool.ndjson.

Trait Implementations§

Source§

impl Clone for RuntimeConfig

Source§

fn clone(&self) -> RuntimeConfig

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 RuntimeConfig

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> Same for T

Source§

type Output = T

Should always be Self
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