Skip to content

Public API

Raul Montoya Cardenas edited this page Jul 29, 2026 · 2 revisions

Public API

Wiki hero

Generated with Grok Build: Grok 4.5 · xAI Imagine (/imagine)

Crate Root Re-exports (lib.rs)

pub mod backend;
pub mod daemon;
pub mod registry;

pub use backend::{BackendPair, IngressPacket, SpikeEvent, SpikeSink, StimulusSource};

Primary Types

Symbol Module Notes
DaemonConfig daemon TOML load + fields
BrainstemDaemon daemon Runtime owner
CORPUS_IPC_READOUT_ENV daemon "SPIKENAUT_ZMQ_READOUT_IPC"
ServiceConfig / ServiceRegistry registry Named services
BackendPair, traits, packet/event backend I/O surface
StubStimulusSource, NoopSpikeSink backend Always available
ZmqStimulusSource, ZmqSpikeSink backend Only with feature = "corpus-ipc"

Constructor Matrix

Method Backend Failure mode
BrainstemDaemon::new(cfg) Always stub Panic on invalid neuron counts
try_new(cfg) Always stub Result
with_backend(cfg, pair) Injected Panic on invalid counts
try_with_backend(cfg, pair) Injected Result (preferred)

Methods

daemon.registry() -> &ServiceRegistry
daemon.run().await -> Result<()>   // consumes self
DaemonConfig::load(path) -> Result<DaemonConfig>

Not Public

  • run_tick (private; test-only run_tick_for_test)
  • decode_inputs (crate-private)
  • CollectingSpikeSink (test-only)

Related


Last updated: July 28, 2026 Updated by: Grok Build: Grok 4.5 Package tip reference: 8176c58 (main)

Clone this wiki locally