Struct DecodeContext 

pub struct DecodeContext<'p> {
    pub limits: Limits,
    pub parallel: bool,
    pub simd: bool,
    pub profiler: &'p Profiler,
    pub recover: bool,
    /* private fields */
}

Context passed to decoders.

Fields

limits: Limits

Safety limits for allocations and dimensions.

parallel: bool

Allow multithreaded decoding.

simd: bool

Allow explicit SIMD kernels (scalar reference paths otherwise).

profiler: &'p Profiler

Receives per-stage timings.

recover: bool

Recover from truncated sensor data (zero-fill and warn) instead of failing. Default: true (the high-level API’s default policy). See crate::integrity.

Implementations

impl<'p> DecodeContext<'p>

pub fn new(profiler: &'p Profiler) -> Self

A context with default limits, parallelism and SIMD enabled.

impl DecodeContext<'_>

pub fn sensor_bytes<'a>( &self, data: &'a [u8], unit: DataUnit, offset: usize, needed: usize, ) -> Result<SensorBytes<'a>>

The bytes [offset, offset + needed) of sensor-data unit in data (the whole input). Under the strict policy a range not entirely in the file is an Error::CorruptFile carrying a Truncation; under the recover policy the available prefix (possibly empty) is returned with the truncation, which the caller reports through DecodeContext::recovered after zero-filling what is missing.

pub fn sensor_rows<'a>( &self, data: &'a [u8], unit: DataUnit, offset: usize, geometry: RowGeometry, ) -> Result<&'a [u8]>

Like DecodeContext::sensor_bytes for a row-structured unit: needed comes from geometry, and a recovered truncation is reported immediately with the samples the available bytes do not cover (callers must leave those zero).

pub fn truncated(&self, t: Truncation, samples_filled: u64) -> Result<()>

Fail with t (strict), or record it as recovered with samples_filled zero samples (recover). For checks made outside DecodeContext::sensor_bytes.

pub fn recovered(&self, reason: CorruptReason, samples_filled: u64)

Record a problem the decode repaired (recover policy).

pub fn take_warnings(&self) -> Vec<DecodeWarning>

Warnings recorded so far, sorted by unit (decoding may run units in parallel).