Skip to main content

Module capabilities

Module capabilities 

Source
Expand description

Type-safe capability system

This module provides a type-safe capability system that replaces the bitflags-based Capabilities type with zero-sized type markers.

§Features

  • Compile-time safety: has::<Infer>() catches typos at compile time
  • Runtime compatibility: has_str("infer") works for Casbin integration
  • Extensible: Add new capabilities without modifying existing code
  • Zero-cost: Capability markers are zero-sized types

§Example

ⓘ
use hyprstream::archetypes::capabilities::{CapabilitySet, Infer, Train, Serve};

// Create a capability set for a model
let mut caps = CapabilitySet::new();
caps.insert::<Infer>();
caps.insert::<Train>();
caps.insert::<Serve>();

// Type-safe checks
if caps.has::<Infer>() {
    println!("Can run inference");
}

// String-based checks (for Casbin)
if caps.has_str("infer") {
    println!("Policy allows inference");
}

// Display format
println!("Capabilities: {}", caps); // "it--s--"

§Builder Patterns

Common capability sets can be created using builders:

ⓘ
let model_caps = CapabilitySet::model();  // infer, train, serve
let data_caps = CapabilitySet::data();    // query, write, serve
let context_caps = CapabilitySet::context(); // context

Structs§

CapabilitySet
A type-safe container for capabilities
Context
Context capability - context-augmented generation
Infer
Inference capability - run model inference
LoraSupport
LoRA support capability - model supports LoRA adapters
Manage
Manage capability - administrative operations
Multimodal
Multimodal capability - model handles multiple modalities
Quantization
Quantization capability - model supports quantization
Query
Query capability - read/query data via SQL
Serve
Serve capability - expose via API
Train
Training capability - train/fine-tune models
UnknownCapability
Error returned when inserting an unknown capability
Write
Write capability - insert/update data

Statics§

KNOWN_CAPABILITY_IDS
All known capability IDs for validation

Traits§

Capability
A capability that a domain can provide

Functions§

is_known_capability
Check if a capability ID is known