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>,
}

Expand description

Utility to build responses for serving a tokio::fs::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( &self, file: File, metadata: Metadata, content_type: String, ) -> Result<Response<Body>>

Build a response for the given file and metadata.

Trait Implementations§

impl Clone for FileResponseBuilder

fn clone(&self) -> FileResponseBuilder

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

impl Debug for FileResponseBuilder

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

Formats the value using the given formatter. Read more

impl Default for FileResponseBuilder

fn default() -> FileResponseBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl Freeze for FileResponseBuilder

impl RefUnwindSafe for FileResponseBuilder

impl Send for FileResponseBuilder

impl Sync for FileResponseBuilder

impl Unpin for FileResponseBuilder

impl UnwindSafe for FileResponseBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

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

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more