`mod atof`#

module atof#

Agent Trajectory Observability Format (ATOF) JSONL exporter support for NeMo Flow.

The AtofExporter registers as an event subscriber and writes each raw NeMo Flow Agent Trajectory Observability Format (ATOF) event as one JSON object per JSONL line.

Types

type Result<T>#: Result type for the ATOF JSONL exporter.

Enums

enum AtofExporterError#

Errors produced while configuring or operating the ATOF JSONL exporter.

CurrentDirectory(std::io::Error)#: Failed to resolve the current working directory for default config.

OpenFile#

Failed to open the output file.

path: PathBuf#: Output path that failed to open.

source: std::io::Error#: Underlying I/O error.

Flush#

Failed while flushing the output file.

path: PathBuf#: Output path that failed to flush.

source: std::io::Error#: Underlying I/O error.

StoredFailure#

The exporter recorded an earlier write or serialization error.

path: PathBuf#: Output path associated with the failure.

message: String#: Stored failure message.

LockPoisoned#: The internal exporter state lock was poisoned.

Runtime(FlowError)#: Runtime subscriber registration failed.

enum AtofExporterMode#

File write behavior for AtofExporter.

Append#: Append events to an existing file or create it if missing.

Overwrite#: Truncate an existing file when the exporter is created.

Implementations

impl AtofExporterMode#

Functions

fn as_str(self) -> &'static str#: Return the stable string representation used by language bindings.

fn parse(value: &str) -> Option<Self>#: Parse a string mode used by language bindings.

Structs and Unions

struct AtofExporter#

Filesystem-backed Agent Trajectory Observability Format (ATOF) JSONL event exporter.

Implementations

impl AtofExporter#

Functions

fn deregister(&self, name: &str) -> Result<bool>#: Deregister a global subscriber by name.

fn force_flush(&self) -> Result<()>#: Flush the underlying file and report any stored write error.

fn new(config: AtofExporterConfig) -> Result<Self>#: Create a new exporter from config and open its output file.

fn path(&self) -> &Path#: Return the output JSONL path.

fn register(&self, name: &str) -> Result<()>#: Register this exporter globally under the given subscriber name.

fn shutdown(&self) -> Result<()>#: Shut down the exporter by flushing any buffered data.

fn subscriber(&self) -> EventSubscriberFn#: Return an event subscriber that writes one JSONL record per observed event.

struct AtofExporterConfig#

Configuration for AtofExporter.

output_directory: PathBuf#: Directory that contains the JSONL output file.

mode: AtofExporterMode#: Append or overwrite behavior used when opening the file.

filename: String#: Output filename.

Implementations

impl AtofExporterConfig#

Functions

fn new() -> Self#: Create a config with defaults.

fn path(&self) -> PathBuf#: Return the full output path for this config.

fn with_filename(mut self, filename: impl Into<String>) -> Self#: Override the output filename.

fn with_mode(mut self, mode: AtofExporterMode) -> Self#: Override the output mode.

fn with_output_directory(mut self, output_directory: impl Into<PathBuf>) -> Self#: Override the output directory.

Traits implemented

impl Default for AtofExporterConfig#

mod atof#

`mod atof`#