Struct hyper_staticfile::util::FileResponseBuilder

pub struct FileResponseBuilder {
    pub cache_headers: Option<u32>,
    pub is_head: bool,
    pub if_modified_since: Option<SystemTime>,
    pub range: Option<String>,
    pub if_range: Option<String>,
}

Utility to build responses for serving a file.

This struct allows direct access to its fields, but these fields are typically initialized by the accessors, using the builder pattern. The fields are basically a bunch of settings that determine the response details.

Fields

cache_headers: Option<u32>

Whether to send cache headers, and what lifespan to indicate.

is_head: bool

Whether this is a HEAD request, with no response body.

if_modified_since: Option<SystemTime>

The parsed value of the If-Modified-Since request header.

range: Option<String>

The file ranges to read, if any, otherwise we read from the beginning.

if_range: Option<String>

The unparsed value of the If-Range request header. May match etag or last-modified.

Implementations

impl FileResponseBuilder

pub fn new() -> Self

Create a new builder with a default configuration.

pub fn request<B>(&mut self, req: &Request<B>) -> &mut Self

Apply parameters based on a request.

pub fn request_parts( &mut self, method: &Method, headers: &HeaderMap ) -> &mut Self

Apply parameters based on request parts.

pub fn request_method(&mut self, method: &Method) -> &mut Self

Apply parameters based on a request method.

pub fn request_headers(&mut self, headers: &HeaderMap) -> &mut Self

Apply parameters based on request headers.

pub fn cache_headers(&mut self, value: Option<u32>) -> &mut Self

Add cache headers to responses for the given lifespan.

pub fn is_head(&mut self, value: bool) -> &mut Self

Set whether this is a HEAD request, with no response body.

pub fn if_modified_since(&mut self, value: Option<SystemTime>) -> &mut Self

Build responses for the given If-Modified-Since date-time.

pub fn if_modified_since_header( &mut self, value: Option<&HeaderValue> ) -> &mut Self

Build responses for the given If-Modified-Since request header value.

pub fn if_range(&mut self, value: Option<&HeaderValue>) -> &mut Self

Build responses for the given If-Range request header value.

pub fn range_header(&mut self, value: Option<&HeaderValue>) -> &mut Self

Build responses for the given Range request header value.

pub fn build<F: IntoFileAccess>( &self, file: ResolvedFile<F> ) -> Result<Response<Body<F::Output>>>

Build a response for the given resolved file.

Trait Implementations

impl Clone for FileResponseBuilder

fn clone(&self) -> FileResponseBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileResponseBuilder

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

Formats the value using the given formatter.

impl Default for FileResponseBuilder

fn default() -> FileResponseBuilder

Returns the “default value” for a type.