Skip to main content

KhiveConfig

Struct KhiveConfig 

Source
pub struct KhiveConfig {
    pub db: Option<String>,
    pub engines: Vec<EngineConfig>,
    pub actor: ActorConfig,
    pub runtime: RuntimeSectionConfig,
    pub backends: Vec<BackendConfig>,
    pub packs: HashMap<String, PackConfig>,
    pub git_write: GitWriteSectionConfig,
    pub storage: StorageSectionConfig,
}
Expand description

Top-level khive configuration loaded from khive.toml or config.toml.

Sections consumed today:

  • [[engines]]: embedding engine declarations
  • [actor]: default namespace / identity (OSS actor model)
  • [runtime]: runtime knobs (namespace, brain_profile)
  • [[backends]]: storage backend declarations (ADR-028)
  • [packs.<name>]: per-pack backend assignments (ADR-028)

Unknown keys are silently ignored by serde — forward-compatible.

Fields§

§db: Option<String>

Typed only so a top-level db key can be rejected loudly by KhiveConfig::validate instead of being silently ignored as an unknown key. Not a supported config-file storage selector: single-file database selection is --db/KHIVE_DB, and storage topology is [[backends]].path.

§engines: Vec<EngineConfig>

Embedding engine declarations.

§actor: ActorConfig

Default actor identity for this khive instance.

When present, actor.id feeds configuration identity and gate/attribution policy input. A non-'local' actor.id is folded into the default READ visible-set at config load (ADR-007 Rev 4 Rule 3b) — it widens what default multi-record reads return, but never routes writes or sets default_namespace. Cloud model derives actor identity from an authenticated token.

§runtime: RuntimeSectionConfig

Runtime knobs: namespace overrides, brain profile, etc.

§backends: Vec<BackendConfig>

Named storage backends (ADR-028).

When absent or empty, a single implicit main backend is used and all packs share it — identical to pre-ADR-028 behavior.

§packs: HashMap<String, PackConfig>

Per-pack backend assignments (ADR-028).

Maps pack name to backend name. Packs absent from this map fall back to the main backend. Validated at load time: every referenced backend name must appear in backends.

§git_write: GitWriteSectionConfig

Git-write policy allowlist (ADR-108 Amendment). Absent or empty allowed fails closed — khive-pack-git’s write verbs are unavailable until this section is populated.

§storage: StorageSectionConfig

Storage-layer config not covered by [[backends]] (ADR-111 Amendment 2: [storage.blob]’s fs/s3 selector).

Implementations§

Source§

impl KhiveConfig

Source

pub fn load(path: Option<&Path>) -> Result<Option<Self>, ConfigError>

Load and validate a KhiveConfig from an explicit path.

Search order:

  1. path argument (explicit override — e.g. from --config / KHIVE_CONFIG)
  2. ./.khive/config.toml (project-local config, relative to the MCP server cwd)

The project-local default collocates config with the khive-test.db that already lives under .khive/ in each project directory. ~/.khive/config.toml is searched by KhiveConfig::load_with_home_fallback when the project-local file is absent.

If the resolved file does not exist, returns Ok(None). A missing config is not an error — callers fall back to the env-var path.

If the file exists but cannot be parsed, returns a ConfigError. After parsing, validate() runs and any logical errors are returned.

Source

pub fn load_with_home_fallback( path: Option<&Path>, db_path: Option<&Path>, ) -> Result<Option<Self>, ConfigError>

Load config with the full resolution order:

  1. Explicit path (from --config / KHIVE_CONFIG)
  2. ./khive.toml (project-local, project root)
  3. <db-dir>/config.toml (project-local, anchored to the resolved database’s own directory — see project_config_anchor_dir)
  4. ~/.khive/config.toml (user-global)

Returns the first file found, or Ok(None) when none exist. Parse errors are propagated immediately — a malformed config is always an error regardless of which tier it came from.

db_path should be the same database path the caller is about to open (or has already resolved). Passing it makes tier 3 resolve identically for any two processes that target the same database, regardless of their process working directory — this is what lets a thin client and a warm daemon serving the same database agree on one config file. Pass None when no database path is known yet; tier 3 then falls back to the process cwd, matching the pre-existing behavior.

Source

pub fn validate(&self) -> Result<(), ConfigError>

Validate the parsed config for logical consistency.

Checks:

  • Exactly one engine has default = true (when the list is non-empty).
  • Engine names are unique.
  • fusion_weight, when present, is > 0.

Model name validity is checked lazily at runtime (the config loader does not import lattice_embed directly to keep the dep surface minimal).

Source

pub fn default_engine(&self) -> Option<&EngineConfig>

Return the engine flagged default = true, or None if the list is empty.

Trait Implementations§

Source§

impl Clone for KhiveConfig

Source§

fn clone(&self) -> KhiveConfig

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 KhiveConfig

Source§

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

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

impl Default for KhiveConfig

Source§

fn default() -> KhiveConfig

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

impl<'de> Deserialize<'de> for KhiveConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. 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> 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> 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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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