Struct FileReader 

pub struct FileReader { /* private fields */ }

A streaming reader over a guest-file read response. A background task pumps chunks into a bounded channel (so a slow consumer applies backpressure rather than buffering the whole file); FileReader::next yields the next chunk, None at end of file. Dropping the reader cancels the download.

Implementations

impl FileReader

pub async fn next(&self) -> Option<Result<Vec<u8>, SailError>>

Yield the next file chunk, or None at end of file. A stream error surfaces as Some(Err(..)).

pub fn close(&self)

Abort the background download, cancelling its gRPC stream even when a next() is stalled awaiting a chunk. Idempotent. A subsequent next() observes end of stream (None); a next() already awaiting may still deliver one final buffered chunk before the end.

pub fn into_stream(self) -> BoxStream<'static, Result<Vec<u8>, SailError>>

Consume the reader into a futures::Stream of chunks, for StreamExt combinators. For tokio::io::AsyncRead, adapt the stream with tokio_util::io::StreamReader.

Trait Implementations

impl Debug for FileReader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for FileReader

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.