cairn-mod 1.7.0

Lightweight, Rust-native ATProto labeler
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

//! Cairn — lightweight Rust-native ATProto labeler.
//!
//! This crate is a library surface (`cairn_mod`) plus a binary
//! (`cairn`) for running a standalone labeler. The library modules
//! mirror the §10 architecture of the [design doc][cairn-design]:
//! storage, writer (single-writer task pattern, §F5), signing
//! (§6.2), auth (§5.2), HTTP routers (§F3/F4/F11/F12), and CLI.
//!
//! Start points:
//! - [`server::router`] for the subscribeLabels + queryLabels
//!   public surface.
//! - [`admin_router`] for the `tools.cairn.admin.*` endpoints.
//! - [`serve::run`] for the full binary lifecycle.
//!
//! [cairn-design]: https://github.com/skydeval/cairn-mod/blob/main/cairn-design.md

#![forbid(unsafe_code)]
#![warn(missing_docs)]

pub mod audit;
pub mod auth;
pub mod cli;
pub mod config;
pub mod credential_file;
pub mod error;
pub mod label;
pub mod labels;
pub mod moderation;
pub mod moderators;
pub mod pds_admin;
pub mod policy;
pub mod report;
pub mod serve;
pub mod server;
pub mod service_record;
pub mod signing;
pub mod signing_key;
pub mod storage;
pub mod writer;
pub mod xrpc_gateway;

pub use auth::{AuthConfig, AuthContext, AuthError, VerifiedCaller};
pub use config::Config;
pub use error::{Error, Result};
pub use label::Label;
pub use labels::emission::{ActionForEmission, LabelDraft};
pub use labels::policy::{LabelEmissionPolicy, LabelSpec};
pub use moderation::policy::StrikePolicy;
pub use moderation::reasons::ReasonVocabulary;
pub use policy::automation::{
    DEFAULT_POLICY_REASON_CODE, PolicyAutomationPolicy, PolicyMode, PolicyRule,
    SYNTHETIC_POLICY_ACTOR_DID,
};
pub use policy::evaluator::{
    ActionForPolicyEval, PendingActionForPolicyEval, PendingResolution, resolve_firing_rule,
};
pub use server::{
    AdminConfig, CreateReportConfig, RetentionConfig, SubscribeConfig, admin_router,
    create_report_router, current_retention_floor, did_document_router, health_router,
    public_router, router as subscribe_router, serve, wellknown_router,
};
pub use signing::{canonical_bytes, label_to_lex_value_with_sig, sign_label, verify_label};
pub use signing_key::SigningKey;
pub use writer::{
    ApplyLabelRequest, ConfirmPendingActionRequest, ConfirmedPendingAction,
    DismissPendingActionRequest, DismissedPendingAction, LabelEvent, NegateLabelRequest,
    RecordActionRequest, RecordedAction, RevokeActionRequest, RevokedAction, SweepBatchResult,
    SweepRequest, SweepResult, WriterHandle, spawn as spawn_writer, spawn_with_pds_admin,
};