[][src]Struct hyper_staticfile::Static

pub struct Static {
    pub root: PathBuf,
    pub cache_headers: Option<u32>,
}

High-level interface for serving static files.

This struct serves files from a single root path, which may be absolute or relative. The request is mapped onto the filesystem by appending their URL path to the root path. If the filesystem path corresponds to a regular file, the service will attempt to serve it. Otherwise, if the path corresponds to a directory containing an index.html, the service will attempt to serve that instead.

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.

This struct also implements the hyper::Service trait, which simply wraps Static::serve.

Fields

root: PathBuf

The root directory path to serve files from.

cache_headers: Option<u32>

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

Methods

impl Static[src]

pub fn new<P: Into<PathBuf>>(root: P) -> Self[src]

Create a new instance of Static with a given root path.

If Path::new("") is given, files will be served from the current directory.

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

Add cache headers to responses for the given lifespan.

pub fn serve<B>(&self, request: Request<B>) -> StaticFuture<B>[src]

Serve a request.

Trait Implementations

impl Clone for Static[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Service for Static[src]

type ReqBody = Body

The Payload body of the http::Request.

type ResBody = Body

The Payload body of the http::Response.

type Error = Error

The error type that can occur within this Service. Read more

type Future = StaticFuture<Body>

The Future returned by this Service.

fn poll_ready(&mut self) -> Result<Async<()>, Self::Error>[src]

Returns Ready when the service is able to process requests. Read more

Auto Trait Implementations

impl Send for Static

impl Sync for Static

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Erased for T