Struct VcdWriter 

pub struct VcdWriter<W = File>
where
    W: Write,
{ /* private fields */ }

Implementations

impl VcdWriter

pub fn new<P>(path: P, descs: &[VcdSignalDesc]) -> Result<VcdWriter, Error>

where P: AsRef<Path>,

pub fn restart<P>(&mut self, path: P) -> Result<(), Error>

where P: AsRef<Path>,

Finish the current file and continue the waveform, with the same signals, in a new file at path. The first dump there records every value, and its timestamps start over.

impl<W> VcdWriter<W>

where W: Write,

pub fn from_writer(writer: W, descs: &[VcdSignalDesc]) -> VcdWriter<W>

pub fn flush(&mut self) -> Result<(), Error>

Publish buffered output, also reporting errors that Drop cannot report.

pub fn statistics(&self) -> VcdStatistics

pub fn get_ref(&self) -> &W

pub fn last_timestamp(&self) -> Option<u64>

The last timestamp written to the file, if any. Later dumps must not be earlier.

pub fn rescan(&mut self)

Make the next Self::dump_backend compare every signal: memory changed without marking VCD activity, for example by restoring a checkpoint.

pub fn dump_backend<B>( &mut self, timestamp: u64, backend: &mut B, external: &[(BigUint, BigUint)], ) -> Result<(), Error>

where B: SimBackend,

Dump as the backend’s sole incremental waveform observer. Multiple writers must consume activity once and share it through dump_with_activity, since each consumption clears the pending flags.

pub fn into_inner(self) -> Result<W, Error>

pub fn add_external_signals( &mut self, descs: &[VcdExternalSignalDesc], ) -> Result<(), Error>

Adds externally supplied signals before the first dump. VCD headers cannot be extended after value changes have started.

pub fn dump(&mut self, timestamp: u64, memory: &[u8]) -> Result<(), Error>

Full-scan reference path, also suitable for uninstrumented/raw memory.

pub fn dump_with_external( &mut self, timestamp: u64, memory: &[u8], external: &[(BigUint, BigUint)], ) -> Result<(), Error>

pub fn dump_with_activity( &mut self, timestamp: u64, memory: &[u8], external: &[(BigUint, BigUint)], activity: Option<&[usize]>, ) -> Result<(), Error>

activity contains unique physical group IDs consumed from TraceLayout. None requests a full scan. Initial values and external signals are always observed, including when no generated store has executed.