Struct FileStream 

pub struct FileStream<S> {
    pub stream: S,
    pub file_name: Option<String>,
    pub content_size: Option<u64>,
}

Available on crate feature file-stream only.

HTTP file stream with metadata support for efficient file delivery.

FileStream wraps any stream that produces bytes and associates it with optional metadata like filename and content size. This enables proper HTTP headers to be set for file downloads, including Content-Disposition for filename suggestions and Content-Length for known file sizes. The implementation supports both regular responses and HTTP range requests for partial content delivery.

Fields

stream: S

The underlying byte stream

file_name: Option<String>

Optional filename for Content-Disposition header

content_size: Option<u64>

Optional content size for Content-Length header

Implementations

impl<S> FileStream<S>

where S: TryStream + Send + 'static, S::Ok: Into<Bytes>, S::Error: Into<Box<dyn Error + Send + Sync>>,

pub fn new( stream: S, file_name: Option<String>, content_size: Option<u64>, ) -> Self

Creates a new file stream with the provided metadata.

pub async fn from_path<P>( path: P, ) -> Result<FileStream<Once<Ready<Result<Bytes, Error>>>>>

where P: AsRef<Path>,

Available on crate feature compio only.

Creates a file stream from a file system path with automatic metadata detection (compio variant).

pub fn into_range_response( self, start: u64, end: u64, total_size: u64, ) -> Response

Creates an HTTP 206 Partial Content response for range requests.

pub async fn try_range_response<P>( path: P, start: u64, end: u64, ) -> Result<Response>

where P: AsRef<Path>,

Available on crate feature compio only.

Try to create a range response for a file stream (compio variant).

Trait Implementations

impl<S> Responder for FileStream<S>

where S: TryStream + Send + 'static, S::Ok: Into<Bytes>, S::Error: Into<Box<dyn Error + Send + Sync>>,

fn into_response(self) -> Response

Converts the file stream into an HTTP response with appropriate headers.