Struct LocalSignal 

pub struct LocalSignal { /* private fields */ }

A recording in this process, its min/max Pyramid (a file for recordings of at least FILE_PYRAMID_MIN_BYTES, else memory) and the builder that fills it in the background, nearest the focus first. The recording is read once to build the pyramid, while views already draw from it.

Implementations

impl LocalSignal

pub fn open( source: Arc<dyn RecordingSource>, recording: Option<(&Path, &str)>, ) -> DspResult<Self>

source, with the pyramid of source id of the recording file path when given: the complete file next to it, else (large recordings) a new file there, else memory.

pub fn source(&self) -> &Arc<dyn RecordingSource>

The recording.

pub fn pyramid(&self) -> &Arc<Pyramid>

The pyramid (complete or filling).

Trait Implementations

impl Drop for LocalSignal

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl SignalBackend for LocalSignal

fn info(&self) -> &RecordingInfo

The recording’s description (channels, samples, exact rate and start, units).

fn view(&self, view: &View, out: &mut Envelope) -> DspResult<()>

The contents of view into out (its buffer is reused). Zoomed-out columns not built yet are NaN and complete is false: ask again after Self::watch reports progress.

fn read( &self, channels: &[usize], samples: Range<u64>, out: &mut [f32], ) -> DspResult<()>

Samples samples of channels, channel-major (e.g. the value under the cursor).

fn focus(&self, sample: u64)

The viewer looks at sample sample: zoomed-out data there is prepared first.

fn prepare(&self, start: u64, end: u64) -> DspResult<()>

Prepares the zoomed-out data of samples start..end now, blocking until it is ready (for a single exact image, e.g. a snapshot; viewers use Self::focus).

fn progress(&self) -> Progress

Samples whose zoomed-out data is ready, of all (done == total once complete).

fn watch(&self, on_progress: OnProgress)

Calls on_progress whenever more zoomed-out data is ready.