cruxx-core 0.2.5

Core types, traits, and runtime for the cruxx agentic DSL
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

/// The Context trait — port for the agent runtime context.
///
/// Dependency inversion: Agent::run depends on this trait, not on CruxCtx directly.
/// CruxCtx is the production adapter. Tests can substitute a mock or no-op context.
use std::future::Future;

use crate::types::budget::Budget;
use crate::types::error::CruxErr;
use crate::types::recovery::Recovery;
use crate::types::step::Step;

pub trait Context: Send {
    /// Execute a named step, recording it in the trace.
    fn step<F, Fut, T>(
        &mut self,
        name: &str,
        f: F,
    ) -> impl Future<Output = Result<T, CruxErr>> + Send
    where
        F: FnOnce() -> Fut + Send,
        Fut: Future<Output = Result<T, CruxErr>> + Send,
        T: serde::Serialize + serde::de::DeserializeOwned + Send;

    /// Execute a named step with a content key for replay identity.
    ///
    /// The key is hashed and stored alongside the step, allowing lenient replay
    /// to distinguish steps that share a name but differ in actual input.
    fn step_keyed<F, Fut, T, K>(
        &mut self,
        name: &str,
        key: &K,
        f: F,
    ) -> impl Future<Output = Result<T, CruxErr>> + Send
    where
        F: FnOnce() -> Fut + Send,
        Fut: Future<Output = Result<T, CruxErr>> + Send,
        T: serde::Serialize + serde::de::DeserializeOwned + Send,
        K: serde::Serialize + Sync;

    /// Execute a named step with an explicit confidence score.
    fn step_with_confidence<F, Fut, T>(
        &mut self,
        name: &str,
        confidence: f32,
        f: F,
    ) -> impl Future<Output = Result<T, CruxErr>> + Send
    where
        F: FnOnce() -> Fut + Send,
        Fut: Future<Output = Result<T, CruxErr>> + Send,
        T: serde::Serialize + serde::de::DeserializeOwned + Send;

    /// Execute a step with automatic retry support.
    fn step_retryable<F, Fut, T>(
        &mut self,
        name: &str,
        confidence: f32,
        make_fut: F,
    ) -> impl Future<Output = Result<T, CruxErr>> + Send
    where
        F: FnMut() -> Fut + Send,
        Fut: Future<Output = Result<T, CruxErr>> + Send,
        T: serde::Serialize + serde::de::DeserializeOwned + Send;

    /// Register a low-confidence handler.
    fn on_low_confidence<F, Fut>(&mut self, threshold: f32, handler: F)
    where
        F: Fn(f32) -> Fut + Send + Sync + 'static,
        Fut: Future<Output = Recovery<serde_json::Value>> + Send + 'static;

    /// Register a step-failure handler.
    fn on_step_failure<F, Fut>(&mut self, handler: F)
    where
        F: Fn(CruxErr) -> Fut + Send + Sync + 'static,
        Fut: Future<Output = Recovery<serde_json::Value>> + Send + 'static;

    /// Register a budget-exceeded handler.
    fn on_budget_exceeded<F, Fut>(&mut self, handler: F)
    where
        F: Fn(Budget) -> Fut + Send + Sync + 'static,
        Fut: Future<Output = Recovery<serde_json::Value>> + Send + 'static;

    /// Set the maximum retries per step.
    fn set_max_retries(&mut self, n: u32);

    /// Set a custom budget.
    fn set_budget(&mut self, budget: Budget);

    /// Record budget consumption.
    fn consume_budget(&mut self, amount: u64);

    /// Get the current budget.
    fn budget(&self) -> &Budget;

    /// Get remaining budget units.
    fn remaining_budget(&self) -> u64;

    /// Current step count.
    fn step_count(&self) -> u32;

    /// View recorded steps.
    fn snapshot_steps(&self) -> &[Step];

    /// Execute a streaming step that collects intermediate events.
    ///
    /// The closure returns a `Stream` of `Result<T, CruxErr>`. Each yielded `Ok(T)` is
    /// recorded as an event on the step. The final item becomes the step output.
    /// All items must succeed; the first `Err` short-circuits and fails the step.
    fn step_stream<F, S, T>(
        &mut self,
        name: &str,
        f: F,
    ) -> impl Future<Output = Result<T, CruxErr>> + Send
    where
        F: FnOnce() -> S + Send,
        S: futures::Stream<Item = Result<T, CruxErr>> + Send + Unpin,
        T: serde::Serialize + serde::de::DeserializeOwned + Send;
}