Skip to main content

Crate nex5file

Crate nex5file 

Source
Expand description

Read, write, and edit data stored in NeuroExplorer .nex and .nex5 files.

Modules§

fixture_paths
Paths to bundled and sibling-repo test recordings.

Structs§

ContinuousVariable
EventVariable
FileData
In-memory representation of a .nex or .nex5 file, mirroring the Python FileData class.
FileDataBuilder
Builds a FileData with a fluent API.
FileDataDiff
Summary of differences between two in-memory files.
FileMetadata
File-level metadata block from a .nex5 file.
FileWritePlan
IntervalVariable
MarkerVariable
NeuronVariable
OpenNexFile
An open .nex / .nex5 file with a cached handle for efficient lazy loading.
PopulationVector
ReadOptions
Options controlling file read behavior.
Reader
Reads and parses NeuroExplorer .nex and .nex5 files.
SpikeExportOptions
Options for spike export.
TimestampRange
Range of timestamps to read from a spike/event variable.
TimestampStream
Callback-driven timestamp reader for one variable payload.
Timestamps
Spike/event timestamps stored as f64 or compact f32 seconds.
VariableDiff
Per-variable difference details.
VariableMetadata
Per-variable metadata entry inside the file JSON block.
VariableWritePlan
Prepared write headers for one variable (does not mutate FileData).
WaveformVariable
Waveform variable with flat sample storage (count × n_points values, row-major).
WriteOptions
Options controlling file write behavior.
Writer
Writes NeuroExplorer .nex and .nex5 files.

Enums§

MarkerFieldValue
NexError
NexFileVarType
Variable type constants matching NeuroExplorer .nex / .nex5 format.
NexFormat
On-disk format selector for Reader::read_from_reader.
SpikeExportFormat
Export format for spike timestamps.
Variable

Constants§

NEX5_MAGIC
NEX_MAGIC

Functions§

ensure_all_payloads_loaded
export_spikes
Write spike timestamps for var_name to any Write target.
export_spikes_to_file
Write spike timestamps to a file.
prepare_nex5_write_plan
prepare_nex_write_plan
read_nex5_file
Convenience function — read as .nex5 (or .nex if extension says so).
read_nex_file
Convenience function — read using file extension to pick format.
spike_export_names
List neuron and event variable names suitable for spike export.
validate_timestamp_range
Validate a timestamp range against a variable header.
write_nex5_file
Convenience function — write as .nex5 (or .nex if extension says so).
write_nex5_file_with_options
Convenience function with custom write options.
write_nex_file
Convenience function — write using file extension to pick format.

Type Aliases§

Result