Struct http_serve::ChunkedReadFile

source · [−]

pub struct ChunkedReadFile<D: 'static + Send + Buf + From<Vec<u8>> + From<&'static [u8]>, E: 'static + Send + Into<Box<dyn StdError + Send + Sync>> + From<Box<dyn StdError + Send + Sync>>> { /* private fields */ }

Expand description

HTTP entity created from a std::fs::File which reads the file chunk-by-chunk within a tokio::task::block_in_place closure.

ChunkedReadFile is cheap to clone and reuse for many requests.

Expects to be served from a tokio threadpool.

type BoxedError = Box<dyn std::error::Error + 'static + Send + Sync>;
async fn serve_dictionary(req: Request<Body>) -> Result<Response<Body>, BoxedError> {
    let f = tokio::task::block_in_place::<_, Result<_, BoxedError>>(
        move || {
            let f = std::fs::File::open("/usr/share/dict/words")?;
            let mut headers = http::header::HeaderMap::new();
            headers.insert(header::CONTENT_TYPE, HeaderValue::from_static("text/plain"));
            Ok(http_serve::ChunkedReadFile::new(f, headers)?)
        },
    )?;
    Ok(http_serve::serve(f, &req))
}

Implementations

source

impl<D, E> ChunkedReadFile<D, E> where
D: 'static + Send + Sync + Buf + From<Vec<u8>> + From<&'static [u8 ]>,
E: 'static + Send + Sync + Into<Box<dyn StdError + Send + Sync>> + From<Box<dyn StdError + Send + Sync>>,

source

pub fn new(file: File, headers: HeaderMap) -> Result<Self, Error>

Creates a new ChunkedReadFile.

read(2) calls will be wrapped in tokio::task::block_in_place calls so that they don’t block the tokio reactor thread on local disk I/O. Note that std::fs::File::open and this constructor (specifically, its call to fstat(2)) may also block, so they typically should be wrapped in tokio::task::block_in_place as well.

source

pub fn new_with_metadata(
 file: File,
 metadata: &Metadata,
 headers: HeaderMap
) -> Result<Self, Error>

Creates a new ChunkedReadFile, with presupplied metadata.

This is an optimization for the case where the caller has already called fstat(2). Note that on Windows, this still may perform a blocking file operation, so it should still be wrapped in tokio::task::block_in_place.

Trait Implementations

source

impl<D: Clone + 'static + Send + Buf + From<Vec<u8>> + From<&'static [u8 ]>, E: Clone + 'static + Send + Into<Box<dyn StdError + Send + Sync>> + From<Box<dyn StdError + Send + Sync>>> Clone for ChunkedReadFile<D, E>

source

fn clone(&self) -> ChunkedReadFile<D, E>

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl<D, E> Entity for ChunkedReadFile<D, E> where
D: 'static + Send + Sync + Buf + From<Vec<u8>> + From<&'static [u8 ]>,
E: 'static + Send + Sync + Into<Box<dyn StdError + Send + Sync>> + From<Box<dyn StdError + Send + Sync>>,

type Data = D

The type of a data chunk. Read more

type Error = E

source

fn len(&self) -> u64

Returns the length of the entity’s body in bytes.

source

fn get_range(
&self,
range: Range<u64>
) -> Box<dyn Stream<Item = Result<Self::Data, Self::Error>> + Send + Sync>

Gets the body bytes indicated by range.

source

fn add_headers(&self, h: &mut HeaderMap)

Adds entity headers such as Content-Type to the supplied Headers object. In particular, these headers are the “other representation header fields” described by RFC 7233 section 4.1; they should exclude Content-Range, Date, Cache-Control, ETag, Expires, Content-Location, and Vary. Read more

source

fn etag(&self) -> Option<HeaderValue>

Returns an etag for this entity, if available. Implementations are encouraged to provide a strong etag. RFC 7232 section 2.1 notes that only strong etags are usable for sub-range retrieval. Read more

source

fn last_modified(&self) -> Option<SystemTime>

Returns the last modified time of this entity, if available. Note that serve may serve an earlier Last-Modified: date than the one returned here if this time is in the future, as required by RFC 7232 section 2.2.1. Read more

source