Skip to content

vox-research-events API Reference (generated)

Crate: vox-research-events · Version: 0.6.0 · Target: Library (lib.rs)

Typed SCIENTIA research event types, PreregistrationV1, and ResearchEventEmitter trait (L1 — pure data, no async runtime).

Typed SCIENTIA research event types, PreregistrationV1, and ResearchEventEmitter trait.

This is an L1 crate (pure data — no async runtime, no DB). All SCIENTIA pipeline components communicate through these types to avoid circular crate dependencies.

ModuleDescription
emitter—
events—
observation—
preregistration—
publication_format—
schema_types—
Dependency Topology, diagram 18 nodes, 7 edges: vox-cli → vox-research-events; vox-cli-research → vox-research-events; vox-orchestrator → vox-research-events; vox-orchestrator-mcp → vox-research-events; vox-publisher → vox-research-events; vox-research-shim → vox-research-events; vox-scientia → vox-research-eventsvox-research-eventsvox-clivox-cli-researchvox-orchestratorvox-orchestrator-mcpvox-publishervox-research-shimvox-scientia
Diagram source
graph {
direction: right
node vox_research_events: "vox-research-events"
node vox_cli: "vox-cli"
vox_cli -> vox_research_events
node vox_cli_research: "vox-cli-research"
vox_cli_research -> vox_research_events
node vox_orchestrator: "vox-orchestrator"
vox_orchestrator -> vox_research_events
node vox_orchestrator_mcp: "vox-orchestrator-mcp"
vox_orchestrator_mcp -> vox_research_events
node vox_publisher: "vox-publisher"
vox_publisher -> vox_research_events
node vox_research_shim: "vox-research-shim"
vox_research_shim -> vox_research_events
node vox_scientia: "vox-scientia"
vox_scientia -> vox_research_events
}
Consumer CrateRole
vox-cliDirect workspace dependent
vox-cli-researchDirect workspace dependent
vox-orchestratorDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
vox-publisherDirect workspace dependent
vox-research-shimDirect workspace dependent
vox-scientiaDirect workspace dependent
KindSymbolSignatureSourceDescription
traitemitter::ResearchEventEmitterpub trait ResearchEventEmitter: Send + Synccrates/vox-research-events/src/emitter.rs#L13-L28Object-safe trait for emitting SCIENTIA research lifecycle events. Implementations must be Send + Sync so they can be held behind Arc.
structemitter::NoopEmitterpub struct NoopEmittercrates/vox-research-events/src/emitter.rs#L31No-op emitter — silently drops all events. Used in tests and during bootstrap.
enumevents::ResearchEventKindpub enum ResearchEventKindcrates/vox-research-events/src/events.rs#L18-L35Coarse event category for filtering without deserializing the payload.
enumevents::ResearchEventpub enum ResearchEventcrates/vox-research-events/src/events.rs#L43-L161Typed SCIENTIA pipeline event. Consumers match on this enum; serde tags allow JSON transport across process boundaries (e.g. orchestrator → publisher).
fnevents::kindpub fn kind(&self) -> ResearchEventKindcrates/vox-research-events/src/events.rs#L164-L183—
structobservation::LearnedProfileRowpub struct LearnedProfileRowcrates/vox-research-events/src/observation.rs#L5-L12A learned model behavior profile row (Mesh §5.5 / Phase 0d scientia_model_profile_learning).
enumobservation::ObservationClasspub enum ObservationClasscrates/vox-research-events/src/observation.rs#L16-L20Classification result from the ScientiaObservationClassifier.
traitobservation::ScientiaObservationClassifierpub trait ScientiaObservationClassifier: Send + Synccrates/vox-research-events/src/observation.rs#L23-L25Trait for classifying a raw telemetry observation into a SCIENTIA signal class.
structobservation::KeywordObservationClassifierpub struct KeywordObservationClassifiercrates/vox-research-events/src/observation.rs#L29Heuristic keyword-based classifier (default implementation).
structobservation::ScientiaWeightExtensionpub struct ScientiaWeightExtensioncrates/vox-research-events/src/observation.rs#L55-L59Extended scoring weights with SCIENTIA signal bonus (Mesh §5.4). Behind feature flag — only affects routing when scientia_weights_enabled = true.
structobservation::PenaltyRecordpub struct PenaltyRecordcrates/vox-research-events/src/observation.rs#L73-L79A penalty record with context (Mesh §5.6).
structpreregistration::SubstrateRefpub struct SubstrateRefcrates/vox-research-events/src/preregistration.rs#L11-L18Reference to the eval substrate (code + data) for reproducibility.
structpreregistration::MetricSpecpub struct MetricSpeccrates/vox-research-events/src/preregistration.rs#L22-L26What to measure and how to aggregate it.
enumpreregistration::StatisticalTestpub enum StatisticalTestcrates/vox-research-events/src/preregistration.rs#L31-L34Frequentist or Bayesian test family.
structpreregistration::TestSpecpub struct TestSpeccrates/vox-research-events/src/preregistration.rs#L38-L46Full test specification including priors (Bayesian) or significance level (frequentist).
structpreregistration::StopRulepub struct StopRulecrates/vox-research-events/src/preregistration.rs#L50-L57Sequential stopping rule — pre-declared to prevent p-hacking.
structpreregistration::DecisionRulepub struct DecisionRulecrates/vox-research-events/src/preregistration.rs#L61-L63Explicit decision rule — what “reject” and “fail to reject” mean in context.
structpreregistration::PreregistrationV1pub struct PreregistrationV1crates/vox-research-events/src/preregistration.rs#L70-L90Signed, content-addressable pre-registration record. The id field holds a Nanopub Trusty URI (content-hash-in-URI) once the pre-registration is published; during drafting it is a provisional local ID.
structpublication_format::ShortFormVariantpub struct ShortFormVariantcrates/vox-research-events/src/publication_format.rs#L10-L21A short-form publication variant lifted from atomic claims.
enumpublication_format::PublicationPlatformpub enum PublicationPlatformcrates/vox-research-events/src/publication_format.rs#L25-L31—
fnpublication_format::max_charspub fn max_chars(&self) -> usizecrates/vox-research-events/src/publication_format.rs#L35-L43Maximum character count for this platform.
fnpublication_format::validate_short_formpub fn validate_short_form(variant: &ShortFormVariant) -> Result<(), String>crates/vox-research-events/src/publication_format.rs#L47-L59Validates that a ShortFormVariant fits within platform limits.
fnpublication_format::adapt_claim_to_platformpub fn adapt_claim_to_platform(crates/vox-research-events/src/publication_format.rs#L63Adapt an atomic claim text to a short-form platform variant. This is a stub — Phase 8 wires the actual vox-constrained-gen emitter.
structpublication_format::FigurePolicypub struct FigurePolicycrates/vox-research-events/src/publication_format.rs#L93-L97Figure policy per Cell/Science 2025: no LLM-generated primary research figures.
structschema_types::SignalProvenancepub struct SignalProvenancecrates/vox-research-events/src/schema_types.rs#L30-L43Provenance record for a discovery signal. All fields are optional in the schema.
enumschema_types::DiscoverySignalStrengthpub enum DiscoverySignalStrengthcrates/vox-research-events/src/schema_types.rs#L48-L52Signal strength level.
enumschema_types::DiscoverySignalFamilypub enum DiscoverySignalFamilycrates/vox-research-events/src/schema_types.rs#L57-L73Signal family classification.
structschema_types::DiscoverySignalpub struct DiscoverySignalcrates/vox-research-events/src/schema_types.rs#L78-L86A SCIENTIA discovery signal (discovery-signal.schema.json).
enumschema_types::FindingCandidateClasspub enum FindingCandidateClasscrates/vox-research-events/src/schema_types.rs#L95-L105Class of a finding candidate.
structschema_types::FindingCandidateConfidencepub struct FindingCandidateConfidencecrates/vox-research-events/src/schema_types.rs#L110-L117Confidence scores for a finding candidate. All fields optional in the schema.
structschema_types::FindingCandidateV1pub struct FindingCandidateV1crates/vox-research-events/src/schema_types.rs#L122-L140A SCIENTIA finding candidate ledger record v1 (finding-candidate.v1.schema.json).
enumschema_types::NoveltySourcepub enum NoveltySourcecrates/vox-research-events/src/schema_types.rs#L149-L155Source system for novelty hits.
structschema_types::NormalizedHitpub struct NormalizedHitcrates/vox-research-events/src/schema_types.rs#L160-L174A single normalized prior-art hit.
enumschema_types::RecencyBucketpub enum RecencyBucketcrates/vox-research-events/src/schema_types.rs#L179-L184Recency bucket for overlap summary.
structschema_types::OverlapSummarypub struct OverlapSummarycrates/vox-research-events/src/schema_types.rs#L189-L196Summary of overlap across all normalized hits.
structschema_types::QueryTracepub struct QueryTracecrates/vox-research-events/src/schema_types.rs#L201-L208A single query trace for audit.
structschema_types::NoveltyEvidenceBundlepub struct NoveltyEvidenceBundlecrates/vox-research-events/src/schema_types.rs#L213-L225A SCIENTIA novelty evidence bundle v1 (novelty-evidence-bundle.v1.schema.json).
structschema_types::RunRefpub struct RunRefcrates/vox-research-events/src/schema_types.rs#L234-L243Reference to a single benchmark run.
structschema_types::EvidencePackV1pub struct EvidencePackV1crates/vox-research-events/src/schema_types.rs#L248-L257A SCIENTIA EvidencePack v1 (evidence-pack.v1.schema.json).
enumschema_types::WorthinessProfilepub enum WorthinessProfilecrates/vox-research-events/src/schema_types.rs#L266-L271Publication profile / target venue.
structschema_types::WorthinessSignalItempub struct WorthinessSignalItemcrates/vox-research-events/src/schema_types.rs#L276-L283A single worthiness signal (gate or diagnostic item).
structschema_types::WorthinessActionItempub struct WorthinessActionItemcrates/vox-research-events/src/schema_types.rs#L288-L292A prioritised next-action recommendation.
structschema_types::WorthinessSignalsV2pub struct WorthinessSignalsV2crates/vox-research-events/src/schema_types.rs#L297-L304A SCIENTIA worthiness signals v2 (worthiness-signals.v2.schema.json).