Struct DiscStream 

pub struct DiscStream {
    pub errors: u64,
    pub skip_errors: bool,
    /* private fields */
}

Disc stream. Reads sectors from any source → PES frames.

Sources: physical drive, ISO file, or any SectorSource. Decrypt, demux, and codec parsing happen internally.

Fields

errors: u64

skip_errors: bool

Implementations

impl DiscStream

pub fn new( reader: Box<dyn SectorSource>, title: DiscTitle, decrypt_keys: DecryptKeys, batch_sectors: u16, content_format: ContentFormat, ) -> Self

Create a disc stream from any sector reader.

Works with physical drives and ISO files — both implement SectorSource. The caller opens the source, scans for titles/keys, and passes them in. The stream handles demuxing, decryption, and codec parsing internally.

pub fn on_event(&mut self, f: impl Fn(Event) + Send + 'static)

Set event handler for sector-level events (binary search, skip, recover).

pub fn with_halt(self, halt: Halt) -> Self

Constructor-time builder: attach a Halt token so that when any clone is cancelled, the next read-retry boundary inside fill_extents returns Err(Halted). Required for Stop to work during dense bad-sector regions (where the outer PES read() loop can spend minutes inside fill_extents before emitting a frame).

Preferred over the post-hoc DiscStream::set_halt bridge — pass the same Halt clone you hand to sweep / patch / mux so every phase observes a single Stop signal.

pub fn set_halt(&mut self, flag: Arc<AtomicBool>)

👎Deprecated since 0.18.0:

use DiscStream::with_halt(Halt) at construction instead

Bridge for callers that haven’t migrated to the DiscStream::with_halt constructor-time path yet. Wraps the supplied Arc<AtomicBool> as a Halt (Halt::from_arc) and stores it in the same internal slot, so a halt installed via either entry point goes through one halt-check inside fill_extents. Calling set_halt after with_halt (or vice versa) replaces the previous token with the new one.

pub fn set_raw(&mut self)

Skip decryption — return raw encrypted bytes. Updates both the metadata-side key field and the wrapped reader’s keys so subsequent read_sectors calls become a pass-through.

pub fn disc(&self) -> Option<&Disc>

Get the scanned Disc (for listing all titles).

Trait Implementations

impl Stream for DiscStream

fn read(&mut self) -> Result<Option<PesFrame>>

Read the next frame, or Ok(None) at end of stream. Returns StreamWriteOnly on a stream opened for writing.

fn write(&mut self, _frame: &PesFrame) -> Result<()>

Write a frame to the sink. Returns StreamReadOnly on a stream opened for reading.

fn finish(&mut self) -> Result<()>

Finalize the stream: flush buffered frames, write any container index (MKV Cues), close the underlying file/socket. Idempotent for read-only streams (no-op).

fn info(&self) -> &DiscTitle

Stream metadata. Stable across reads — implementors must return a consistent reference for the lifetime of the stream.

fn codec_private(&self, track: usize) -> Option<Vec<u8>>

Codec initialization data for a track (SPS/PPS, AC-3 fscod, etc.). None for tracks that don’t need codec_private (raw passthrough).

fn headers_ready(&self) -> bool

True when codec_private is available for every video track — callers buffer input frames until this flips, since some output formats (MKV) can’t write frames without codec init data.

fn errors(&self) -> u64

Cumulative count of read errors the stream skipped past (e.g. zero-filled bad sectors on a live drive). Default 0 for streams that don’t have a notion of skip-on-error (file ISO, network, stdio, the pipeline highway, etc.); concrete impls with adaptive retry (DiscStream on the drive single-pass path) override.