Skip to content

vox-publisher API Reference (generated)

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

Unified news syndication and publishing for vox

Syndication / scientia publishing surfaces (Reddit, YouTube, scholarly external jobs).

FeatureDefault / Enables
default—
live-api-canary—
scholarly-external-jobsdep:vox-db
scientia-bluesky—
scientia-bluesky-sdk—
scientia-discord—
scientia-linkedin—
scientia-mastodon—
scientia-opencollective—
scientia-reddit—
scientia-twitter—
scientia-youtube—
DependencyKind
vox-bounded-fsNormal
vox-configNormal
vox-dbNormal
vox-forgeNormal
vox-foundationNormal
vox-http-clientNormal
vox-jsonschema-utilNormal
vox-research-eventsNormal
vox-scientiaNormal
vox-secretsNormal
vox-research-eventsDevelopment
ModuleDescription
atlas—
publisher—
adapters—
archive_run—
citation_cff—
contract—
crossref_metadata—
gate—
openreview_api_types—
publication—
publication_preflight—
publication_worthiness—
research_mesh—
scientia_autofill—
scientia_contracts—
scientia_discovery—
scientia_evidence—
scientia_finding_ledger—
scientia_heuristics—
scientia_prior_art—
scientia_producers—
scientia_semantic—
scholarly—
distribution_compile—
peer_review_gate—
scholarly_remote_status—
scientia_novelty_assess—
scientia_scholarly—
scientia_worthiness_enrich—
scientific_metadata—
submission—
switching—
templates—
topic_packs—
types—
venue_catalog—
zenodo_api_types—
zenodo_metadata—
adapter_health—
handoff—
syndicate—
Dependency Topology, diagram 120 nodes, 19 edges: vox-publisher → vox-bounded-fs; vox-publisher → vox-config; vox-publisher → vox-db; vox-publisher → vox-forge; vox-publisher → vox-foundation; vox-publisher → vox-http-client; vox-publisher → vox-jsonschema-util; vox-publisher → vox-research-events; vox-publisher → vox-scientia;…vox-publishervox-bounded-fsvox-configvox-dbvox-forgevox-foundationvox-http-clientvox-jsonschema-utilvox-research-eventsvox-scientiavox-secretsvox-clivox-cli-civox-cli-researchvox-guivox-orchestratorvox-orchestrator-mcpvox-plugin-publicationvox-populivox-research-shim
Diagram source
graph {
direction: right
node vox_publisher: "vox-publisher"
node vox_bounded_fs: "vox-bounded-fs"
vox_publisher -> vox_bounded_fs
node vox_config: "vox-config"
vox_publisher -> vox_config
node vox_db: "vox-db"
vox_publisher -> vox_db
node vox_forge: "vox-forge"
vox_publisher -> vox_forge
node vox_foundation: "vox-foundation"
vox_publisher -> vox_foundation
node vox_http_client: "vox-http-client"
vox_publisher -> vox_http_client
node vox_jsonschema_util: "vox-jsonschema-util"
vox_publisher -> vox_jsonschema_util
node vox_research_events: "vox-research-events"
vox_publisher -> vox_research_events
node vox_scientia: "vox-scientia"
vox_publisher -> vox_scientia
node vox_secrets: "vox-secrets"
vox_publisher -> vox_secrets
node vox_cli: "vox-cli"
vox_cli -> vox_publisher
node vox_cli_ci: "vox-cli-ci"
vox_cli_ci -> vox_publisher
node vox_cli_research: "vox-cli-research"
vox_cli_research -> vox_publisher
node vox_gui: "vox-gui"
vox_gui -> vox_publisher
node vox_orchestrator: "vox-orchestrator"
vox_orchestrator -> vox_publisher
node vox_orchestrator_mcp: "vox-orchestrator-mcp"
vox_orchestrator_mcp -> vox_publisher
node vox_plugin_publication: "vox-plugin-publication"
vox_plugin_publication -> vox_publisher
node vox_populi: "vox-populi"
vox_populi -> vox_publisher
node vox_research_shim: "vox-research-shim"
vox_research_shim -> vox_publisher
}
Consumer CrateRole
vox-cliDirect workspace dependent
vox-cli-ciDirect workspace dependent
vox-cli-researchDirect workspace dependent
vox-guiDirect workspace dependent
vox-orchestratorDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
vox-plugin-publicationDirect workspace dependent
vox-populiDirect workspace dependent
vox-research-shimDirect workspace dependent
KindSymbolSignatureSourceDescription
structadapter_health::AdapterHealthReportpub struct AdapterHealthReportcrates/vox-publisher/src/adapter_health.rs#L5-L8—
structadapter_health::AdapterHealthEntrypub struct AdapterHealthEntrycrates/vox-publisher/src/adapter_health.rs#L11-L17—
enumadapter_health::HeartbeatStatuspub enum HeartbeatStatuscrates/vox-publisher/src/adapter_health.rs#L21-L28—
fnadapter_health::report_healthpub async fn report_health(crates/vox-publisher/src/adapter_health.rs#L30—
enumarchive_run::ArchiveSteppub enum ArchiveStepcrates/vox-publisher/src/archive_run.rs#L12-L21—
fnarchive_run::namepub fn name(&self) -> &'static strcrates/vox-publisher/src/archive_run.rs#L26-L35Stable snake_case name (does not depend on serde config).
structarchive_run::ArchiveRunPlanpub struct ArchiveRunPlancrates/vox-publisher/src/archive_run.rs#L39-L42—
fnarchive_run::first_blockerpub fn first_blocker(&self) -> Option<&str>crates/vox-publisher/src/archive_run.rs#L46-L48—
fnarchive_run::step_namespub fn step_names(&self) -> Vec<&'static str>crates/vox-publisher/src/archive_run.rs#L52-L54Stable snake_case names of the planned steps, in order.
fnarchive_run::plan_archive_runpub fn plan_archive_run(crates/vox-publisher/src/archive_run.rs#L64Build the archive-run plan. Blocks (returns blockers, no steps) when required manifest fields are missing or when no approved review decision is recorded. Otherwise emits the ordered step preview, inserting [ArchiveStep::ZenodoPublish] just before [ArchiveStep::RecordReceipt] only when include_publish is set.
fncitation_cff::render_citation_cffpub fn render_citation_cff(manifest: &PublicationManifest) -> Result<String, serde_yaml::Error>crates/vox-publisher/src/citation_cff.rs#L38-L122Render CITATION.cff YAML (version 1.2.0) for the manifest. Authors are taken from metadata_json.scientific_publication.authors when present; otherwise a single author uses [PublicationManifest::author].
structcontract::NewsSiteConfigpub struct NewsSiteConfigcrates/vox-publisher/src/contract.rs#L37-L42Site configuration for RSS links and feed file location.
fncontract::from_default_with_operator_envpub fn from_default_with_operator_env() -> Selfcrates/vox-publisher/src/contract.rs#L56-L60Default site layout with VOX_NEWS_SITE_BASE_URL / VOX_NEWS_RSS_FEED_PATH overrides when set.
fncontract::merge_operator_env_overridespub fn merge_operator_env_overrides(&mut self)crates/vox-publisher/src/contract.rs#L63-L80Apply VOX_NEWS_SITE_BASE_URL and VOX_NEWS_RSS_FEED_PATH when non-empty.
fncontract::news_item_linkpub fn news_item_link(&self, news_id: &str) -> Stringcrates/vox-publisher/src/contract.rs#L83-L85—
fncontract::feed_self_linkpub fn feed_self_link(&self) -> Stringcrates/vox-publisher/src/contract.rs#L88-L90—
fncontract::validate_github_repopub fn validate_github_repo(repo: &str) -> anyhow::Result<()>crates/vox-publisher/src/contract.rs#L94-L100Validate owner/repo format.
fncontract::validate_news_idpub fn validate_news_id(id: &str) -> anyhow::Result<()>crates/vox-publisher/src/contract.rs#L103-L111Reject path traversal in logical news ids (filename stems).
fncontract::clamp_textpub fn clamp_text(input: &str, max_chars: usize) -> Stringcrates/vox-publisher/src/contract.rs#L115-L127Clamp text to max_chars preserving UTF-8 boundaries and adding ... when truncated.
fncrossref_metadata::spdx_license_urlpub fn spdx_license_url(spdx: &str) -> Option<&'static str>crates/vox-publisher/src/crossref_metadata.rs#L13-L30Map common SPDX identifiers to a public license URL when known.
fncrossref_metadata::crossref_work_export_jsonpub fn crossref_work_export_json(manifest: &PublicationManifest) -> serde_json::Valuecrates/vox-publisher/src/crossref_metadata.rs#L34-L126Crossref-oriented work metadata as JSON (schema is a Vox extension label).
structdistribution_compile::ChannelPlanpub struct ChannelPlancrates/vox-publisher/src/distribution_compile.rs#L56-L62One enabled channel with resolved caps (after projection profile lookup).
structdistribution_compile::DistributionCompileReportpub struct DistributionCompileReportcrates/vox-publisher/src/distribution_compile.rs#L66-L70Output of [compile_for_publish]: digest, optional warnings, and per-channel plans.
fndistribution_compile::compile_for_publishpub fn compile_for_publish(item: &UnifiedNewsItem) -> DistributionCompileReportcrates/vox-publisher/src/distribution_compile.rs#L84Build a stable digest and channel plan from the news item as syndicated today.
fndistribution_compile::validate_topic_pack_projection_profilespub fn validate_topic_pack_projection_profiles() -> Result<(), String>crates/vox-publisher/src/distribution_compile.rs#L327-L358Validate every template_profile value used in embedded topic packs exists in projection profiles.
enumgate::PublicationApprovalModepub enum PublicationApprovalModecrates/vox-publisher/src/gate.rs#L8-L11—
structgate::GateReasonpub struct GateReasoncrates/vox-publisher/src/gate.rs#L14-L17—
structgate::PublishGateInputspub struct PublishGateInputscrates/vox-publisher/src/gate.rs#L20-L27—
structgate::PublishGateDecisionpub struct PublishGateDecisioncrates/vox-publisher/src/gate.rs#L30-L38—
fngate::has_blockerspub fn has_blockers(&self) -> boolcrates/vox-publisher/src/gate.rs#L42-L44—
fngate::env_publish_armedpub fn env_publish_armed() -> boolcrates/vox-publisher/src/gate.rs#L56-L61VOX_NEWS_PUBLISH_ARMED=1 / true (same sentinel as orchestrator + MCP news tools).
fngate::publish_gate_inputs_for_orchestratorpub fn publish_gate_inputs_for_orchestrator(crates/vox-publisher/src/gate.rs#L65Build gate inputs for the orchestrator news tick (config.news).
fngate::publish_gate_inputs_for_clipub fn publish_gate_inputs_for_cli(crates/vox-publisher/src/gate.rs#L84Manual CLI / headless operator (vox db publication-publish): armed via env only (no orchestrator config loaded).
fngate::publish_gate_inputs_for_mcppub fn publish_gate_inputs_for_mcp(crates/vox-publisher/src/gate.rs#L102MCP Scientia tools: combine tool dry_run, orchestrator [news].dry_run, and manifest syndication.dry_run.
fngate::evaluate_publish_gatepub fn evaluate_publish_gate(inputs: PublishGateInputs) -> PublishGateDecisioncrates/vox-publisher/src/gate.rs#L121-L131—
structgate::PublicationGateInputspub struct PublicationGateInputscrates/vox-publisher/src/gate.rs#L134-L142—
fngate::evaluate_publication_gatepub fn evaluate_publication_gate(inputs: PublicationGateInputs) -> PublishGateDecisioncrates/vox-publisher/src/gate.rs#L145-L180—
structhandoff::SyndicationHandoffPayloadV1pub struct SyndicationHandoffPayloadV1crates/vox-publisher/src/handoff.rs#L22-L31Server-bound handoff payload emitted by vox scientia syndication-export and consumed by vox-ops-syndication (POST /v1/syndication/handoff).
fnhandoff::compute_content_sha3_256pub fn compute_content_sha3_256(content_markdown: &str) -> Stringcrates/vox-publisher/src/handoff.rs#L35-L39Compute the lowercase hex SHA3-256 digest of a news item’s markdown body.
fnhandoff::active_handoff_channelspub fn active_handoff_channels(item: &UnifiedNewsItem) -> Vec<String>crates/vox-publisher/src/handoff.rs#L43-L73Collect the active server-bound social channels configured on a [UnifiedNewsItem].
fnhandoff::build_syndication_handoff_payloadpub fn build_syndication_handoff_payload(crates/vox-publisher/src/handoff.rs#L76Build and schema-validate a [SyndicationHandoffPayloadV1] from a [UnifiedNewsItem] and optional [ApprovalToken].
fnhandoff::validate_handoff_payload_schemapub fn validate_handoff_payload_schema(payload: &SyndicationHandoffPayloadV1) -> Result<()>crates/vox-publisher/src/handoff.rs#L118-L126Validate a [SyndicationHandoffPayloadV1] against contracts/scientia/syndication-handoff.v1.schema.json.
structopenreview_api_types::OpenReviewMetadataOverlaypub struct OpenReviewMetadataOverlaycrates/vox-publisher/src/openreview_api_types.rs#L7-L11Optional metadata_json.openreview overlay for invitations/signatures/readers.
structopenreview_api_types::ManifestMetadataOpenReviewRootpub struct ManifestMetadataOpenReviewRootcrates/vox-publisher/src/openreview_api_types.rs#L14-L17—
structopenreview_api_types::OpenReviewLoginRequestpub struct OpenReviewLoginRequestcrates/vox-publisher/src/openreview_api_types.rs#L21-L24Login POST /login.