Skip to main content

Crate wavetools

Crate wavetools 

Source

Structs§

NameOptions
Options for formatting variable names
SignalInfo
Per-handle signal info: one or more variable declarations that share the same underlying signal data (aliases).
SignalOutputOptions
Options for outputting signals
VarEntry
A single variable declaration: name, metadata, and optional attributes. Aliased signals (same handle/id code) each get their own entry since they can have different declared types.
VarMeta
Variable metadata normalized across FST and VCD formats
VcdData
A streaming VCD reader that yields signal changes on demand

Enums§

WaveFormat
Waveform file formats that can be forced via --format
WaveReader
A reader backed by either an FST file (streamed via callbacks) or a VCD file (streamed via an iterator-style parser)

Functions§

compare_signal_meta
Compare metadata and attributes for signals that share the same name across two files. Returns a list of human-readable difference strings. Direction is only compared if both sides have an explicit (non-implicit) direction.
compare_signal_names
Compare signal names between two waveform files and return the differences
diff_wave_sets
Compare two sets of waveform files and write differences.
diff_waves
Compare two waveform files (any mix of FST/VCD) and write differences
merge_signal_maps
Merge multiple SignalMaps into one with remapped handles.
names_only
Extract just the names from a SignalMap, for use in streaming code
open_and_read_wave_sets
Open two sets of waveform files and return readers and merged hierarchies
open_and_read_waves
Open two waveform files (any mix of FST/VCD) and return both readers and hierarchies
open_wave_file
Open a waveform file (FST or VCD) and build its hierarchy
open_wave_file_with_format
Open a waveform file, optionally forcing a specific format.
open_wave_files
Open multiple waveform files and merge their hierarchies.
write_attrs
Write all signal attributes from the hierarchy to a writer
write_names
Write all variable names from the hierarchy to a writer
write_signals_wave
Write signal values from a WaveReader to a writer
write_signals_wave_multi
Write signal values from multiple WaveReaders, merging their outputs in time order.

Type Aliases§

SignalMap
Mapping from signal handle indices to their full info
SignalNames
Mapping from signal handle indices to their fully qualified hierarchical names