Skip to main content

smeltery_watchfire/
lib.rs

1//! Watchfire, the agent runtime of the [Smeltery](https://github.com/smelteryworks/smeltery)
2//! framework: supervised long-running agents, background jobs on a queue, and a scheduler, on
3//! one Tokio runtime. Apps use it as `smeltery::watchfire`.
4#![doc = include_str!("../README.md")]
5#![cfg_attr(docsrs, feature(doc_cfg))]
6
7mod agent;
8mod alert;
9mod app;
10#[cfg(test)]
11mod backend_tests;
12mod config;
13mod console;
14mod coord;
15#[cfg(test)]
16mod coord_tests;
17mod ctx;
18mod error;
19pub mod http;
20#[cfg(feature = "llm")]
21#[cfg_attr(docsrs, doc(cfg(feature = "llm")))]
22pub mod llm;
23#[cfg(feature = "mail")]
24#[cfg_attr(docsrs, doc(cfg(feature = "mail")))]
25pub mod mail;
26pub mod migrations;
27mod policy;
28mod queue;
29mod registry;
30mod remote;
31mod runtime;
32mod schedule;
33mod status;
34mod store;
35pub mod testing;
36mod time;
37pub mod web;
38
39pub use agent::{Agent, Event, FnAgent, agent_fn};
40pub use alert::{Alert, AlertKind};
41pub use app::{AgentsExt, WatchfireSettings};
42pub use config::{AgentConfig, MAX_NAME_LEN};
43pub use ctx::{AgentCtx, AgentLog, Counter, Permit, Ticker};
44pub use error::{AgentError, BoxError, Error, StoreError};
45pub use http::Http;
46pub use policy::{Backoff, Restart};
47pub use queue::{DeadLetter, Job, JobCtx, JobId, Queue, QueueStats};
48pub use registry::{AgentBuilder, GroupBuilder, Watchfire};
49pub use runtime::Agents;
50pub use schedule::{Cron, Overlap, ScheduleBuilder, ScheduleInfo, ScheduledTask};
51pub use status::{AgentState, AgentStatus, Health, LogLine, RunOutcome, RunRecord};
52pub use time::{DurationExt, Rate, RateExt, format_utc};
53pub use tokio_util::sync::CancellationToken;
54
55/// Everything an agents or jobs file needs: `use smeltery::watchfire::prelude::*;`.
56pub mod prelude {
57    pub use crate::agent::{Agent, Event, agent_fn};
58    pub use crate::app::AgentsExt;
59    pub use crate::config::AgentConfig;
60    pub use crate::ctx::AgentCtx;
61    pub use crate::error::AgentError;
62    pub use crate::policy::Restart;
63    pub use crate::queue::{Job, JobCtx};
64    pub use crate::registry::Watchfire;
65    pub use crate::runtime::Agents;
66    pub use crate::schedule::Overlap;
67    pub use crate::status::{AgentState, RunOutcome};
68    pub use crate::time::{DurationExt, RateExt};
69}