Struct Stream 

pub struct Stream<T: StreamType> { /* private fields */ }

Generic audio stream with sync Read + Seek.

T is a marker type defining the stream source (Hls, File, etc.). Stream holds the source directly and implements Read + Seek by calling Source::wait_range() and Source::read_at().

Implementations

impl<T: StreamType> Stream<T>

pub async fn new(config: T::Config) -> Result<Self, SourceError>

Create a new stream from configuration.

Errors

Returns an error if the underlying stream source cannot be created.

pub fn is_empty(&self) -> Option<bool>

pub fn position(&self) -> u64

Get current read position.

pub fn seek_time_anchor( &mut self, position: Duration, ) -> Result<Option<SourceSeekAnchor>, Error>

Resolve a deterministic time-based seek anchor.

Returns None for sources without segmented time mapping.

Errors

Returns an error when the source failed to resolve the anchor.

pub fn source(&self) -> &T::Source

Get shared reference to inner source.

pub fn timeline(&self) -> Timeline

Get stream timeline.

pub fn phase(&self) -> SourcePhase

Overall source readiness at current position.

pub fn phase_at(&self, range: Range<u64>) -> SourcePhase

Point-in-time readiness for a specific byte range.

pub fn media_info(&self) -> Option<MediaInfo>

Get current media info if known.

pub fn abr_handle(&self) -> Option<AbrHandle>

Runtime ABR handle — Some for adaptive sources (HLS).

pub fn current_variant(&self) -> Option<VariantInfo>

Current variant metadata — Some for adaptive sources (HLS).

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

Get total length if known.

pub fn current_segment_range(&self) -> Option<Range<u64>>

Get current segment byte range (for segmented sources like HLS). Transitional — removed in Plan 06.

pub fn format_change_segment_range(&self) -> StreamResult<Range<u64>>

Header byte range for decoder recreate after a format change. Transitional — removed in Plan 06.

Errors

Err(SourceError::FormatChangeNotApplicable) for non-HLS sources or HLS variants activated with served_from > 0 (init prefix unreachable via Stream reads).

pub fn clear_variant_fence(&mut self)

Clear variant fence, allowing reads from the next variant.

pub fn has_variant_change_pending(&self) -> bool

true while a cross-variant fence keeps read_at / wait_range short-circuited to Pending(VariantChange) / Interrupted.

pub fn set_seek_epoch(&mut self, seek_epoch: u64)

Set seek epoch for stale request invalidation.

pub fn notify_waiting(&self)

Wake any blocked wait_range() calls.

pub fn make_notify_fn(&self) -> Option<Box<dyn Fn() + Send + Sync>>

Create a lock-free callback for waking blocked wait_range().

pub fn commit_seek_landing(&mut self, anchor: Option<SourceSeekAnchor>)

Commit the actual post-seek landing after decoder.seek(...).

pub fn take_reader_hooks(&mut self) -> Option<SharedHooks>

Build a fresh reader-side hooks instance from the inner source.

pub fn as_segment_layout(&self) -> Option<Arc<dyn SegmentLayout>>

Optional segment-layout handle for segment-aware decoders.

pub fn set_position(&self, pos: u64)

Absolute byte-position set — used by Stream::seek callers and audio FSM landings. Forwards to the source’s atomic cursor.

impl<T: StreamType> Stream<T>

pub fn try_read( &mut self, buf: &mut [u8], ) -> Result<StreamReadOutcome, StreamReadError>

Typed read — returns a StreamReadOutcome discriminating progress (Bytes with NonZeroUsize) from non-progress (Pending with a typed PendingReason) and natural EOF. Only genuine source I/O failures surface as StreamReadError::Source. impl Read for Stream wraps this outcome for std::io::Read consumers.

Trait Implementations

impl<T: StreamType> Read for Stream<T>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

impl<T: StreamType> Seek for Stream<T>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

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

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.