Struct TemplatePack 

pub struct TemplatePack { /* private fields */ }

Example pack joining vocabulary, handlers, dependencies, and a runtime handle.

See crates/khive-pack-template/docs/api/pack-scaffold.md.

Implementations

impl TemplatePack

pub fn new(runtime: KhiveRuntime) -> Self

Bind the template pack to the runtime used by its handlers.

Trait Implementations

impl Pack for TemplatePack

const NOTE_KINDS: &'static [&'static str] = vocab::NOTE_KINDS

Declare note kinds this pack contributes. Must not overlap with other packs.

const ENTITY_KINDS: &'static [&'static str] = vocab::ENTITY_KINDS

Declare entity kinds this pack contributes. Must not overlap with other packs.

const HANDLERS: &'static [HandlerDef]

Handler table. Each entry is one verb or subhandler the pack can dispatch.

const REQUIRES: &'static [&'static str]

Pack dependencies. The named packs must be in the configured KHIVE_PACKS list.

const NAME: &'static str = PACK_NAME

Short identifier for this pack (e.g. “kg”, “tasks”).

const EDGE_RULES: &'static [EdgeEndpointRule] = _

Additional edge endpoint rules this pack contributes.

const ENTITY_TYPES: &'static [EntityTypeDef] = _

Entity-type subtypes this pack contributes to the (EntityKind, entity_type) registry (the entity_type axis is distinct from and finer-grained than the closed EntityKind taxonomy — see khive-types::entity_type::EntityTypeRegistry).

const NOTE_KIND_SPECS: &'static [NoteKindSpec] = _

Lifecycle and schema specs for note kinds this pack owns.

const SCHEMA_PLAN: Option<PackSchemaPlan> = None

Pack-auxiliary schema plan.

const VALIDATION_RULES: &'static [&'static str] = _

Validation rule IDs contributed by this pack.

impl PackRuntime for TemplatePack

fn dispatch<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, verb: &'life1 str, params: Value, _registry: &'life2 VerbRegistry, token: &'life3 NamespaceToken, ) -> Pin<Box<dyn Future<Output = Result<Value, RuntimeError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Dispatch a declared verb or return invalid-input for an unknown name.

fn name(&self) -> &str

Pack name — must equal <Self as Pack>::NAME.

fn note_kinds(&self) -> &'static [&'static str]

Note kinds this pack owns — must equal <Self as Pack>::NOTE_KINDS.

fn entity_kinds(&self) -> &'static [&'static str]

Entity kinds this pack owns — must equal <Self as Pack>::ENTITY_KINDS.

fn handlers(&self) -> &'static [HandlerDef]

Handlers this pack registers — must equal <Self as Pack>::HANDLERS.

fn requires(&self) -> &'static [&'static str]

Pack names whose vocabulary this pack references. Defaults to empty so existing packs compile without changes.

fn edge_rules(&self) -> &'static [EdgeEndpointRule]

Pack-extensible edge endpoint rules — must equal <Self as Pack>::EDGE_RULES. Defaults to empty so existing packs that don’t extend the edge contract can ignore it.

fn entity_types(&self) -> &'static [EntityTypeDef]

Pack-extensible entity-type subtypes — must equal <Self as Pack>::ENTITY_TYPES. Defaults to empty so existing packs that don’t extend the entity_type registry can ignore it.

fn note_kind_specs(&self) -> &'static [NoteKindSpec]

NoteKindSpec declarations for note kinds this pack owns.

fn kind_hook(&self, _kind: &str) -> Option<Arc<dyn KindHook>>

Optional per-kind hook for shared CRUD specialization.

fn schema_plan(&self) -> SchemaPlan

Pack-auxiliary schema.

fn validation_rules(&self) -> &'static [ValidationRule]

Domain-specific validation rules contributed by this pack.

fn register_embedders(&self, _runtime: &KhiveRuntime)

Register custom embedding providers with the runtime. Called during pack initialisation, before the first verb dispatch, so KhiveRuntime::embedder(name) resolves provider names declared here. Default no-op — packs that only use built-in lattice models do not need to override this. See docs/api/pack.md#register_embedders for a usage example.

fn register_entity_type_validator(&self, _runtime: &KhiveRuntime)

Install a pack-owned entity-type validator on the runtime, called during pack initialisation (after the registry is built, before the first dispatch) so create_many/create_entity reject unregistered entity_type values at the runtime layer. Default no-op leaves the validator absent (skip-when-None). See docs/api/pack.md#register_entity_type_validator for the two-hook compatibility contract.

fn register_entity_type_validator_with_types( &self, runtime: &KhiveRuntime, _pack_entity_types: &[EntityTypeDef], )

Install a pack-owned entity-type validator that also receives the boot-time composed set of every loaded pack’s ENTITY_TYPES (VerbRegistry::all_entity_types). Defaults to calling register_entity_type_validator with just the runtime. call_register_entity_type_validators calls this hook, not the simpler one — override this to receive the composed vocabulary. See docs/api/pack.md#register_entity_type_validator for the two-hook compatibility contract.

fn register_note_mutation_hook(&self, _runtime: &KhiveRuntime)

Install a pack-owned note-mutation hook on the runtime, called during pack initialisation with the same timing as register_entity_type_validator. Packs that cache derived state keyed by note content (e.g. khive-pack-memory’s warm ANN index) override this to install a hook via KhiveRuntime::install_note_mutation_hook. Default no-op leaves the hook absent. See docs/api/pack.md#register_note_mutation_hook for cross-pack notification rationale.

fn warm<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Warm up any in-memory state from persisted snapshots (optional). Called after all packs are registered but before serving the first request. Must be idempotent and infallible — errors are logged internally, never propagated.

fn registered_embedding_model_names(&self) -> Vec<String>

Names of all embedding models registered on this pack’s underlying runtime handle. Defaults to empty — only packs that own embedding-bearing verbs (kg, memory) need to override this. See docs/api/pack.md#registered_embedding_model_names for the ADR-103 consumer.