[][src]Struct rocket_contrib::serve::StaticFiles

pub struct StaticFiles { /* fields omitted */ }

Custom handler for serving static files.

This handler makes it simple to serve static files from a directory on the local file system. To use it, construct a StaticFiles using either StaticFiles::from() or StaticFiles::new() then simply mount the handler at a desired path.

Options

The handler's functionality can be customized by passing an Options to StaticFiles::new().

Example

To serve files from the /static directory at the /public path, allowing index.html files to be used to respond to requests for a directory (the default), you might write the following:

use rocket_contrib::serve::StaticFiles;

fn main() {
    rocket::ignite()
        .mount("/public", StaticFiles::from("/static"))
        .launch();
}

With this set-up, requests for files at /public/<path..> will be handled by returning the contents of /static/<path..>. Requests for directories at /public/<directory> will be handled by returning the contents of /static/<directory>/index.html.

If your static files are stored relative to your crate and your project is managed by Cargo, you should either use a relative path and ensure that your server is started in the crate's root directory or use the CARGO_MANIFEST_DIR to create an absolute path relative to your crate root. For example, to serve files in the static subdirectory of your crate at /, you might write:

use rocket_contrib::serve::StaticFiles;

fn main() {
    rocket::ignite()
        .mount("/", StaticFiles::from(concat!(env!("CARGO_MANIFEST_DIR"), "/static")))
        .launch();
}

Methods

impl StaticFiles
[src]

Constructs a new StaticFiles that serves files from the file system path. By default, Options::Index is enabled. To serve static files with other options, use StaticFiles::new().

Example

Serve the static files in the /www/public local directory on path /static.

use rocket_contrib::serve::StaticFiles;

fn main() {
    rocket::ignite()
        .mount("/static", StaticFiles::from("/www/public"))
        .launch();
}

Constructs a new StaticFiles that serves files from the file system path with options enabled.

Example

Serve the static files in the /www/public local directory on path /static without serving index files or dot files. Additionally, serve the same files on /pub while also seriving index files and dot files.

use rocket_contrib::serve::{StaticFiles, Options};

fn main() {
    let options = Options::Index | Options::DotFiles;
    rocket::ignite()
        .mount("/static", StaticFiles::from("/www/public"))
        .mount("/pub", StaticFiles::new("/www/public", options))
        .launch();
}

Trait Implementations

impl Clone for StaticFiles
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl Into<Vec<Route>> for StaticFiles
[src]

Performs the conversion.

impl Handler for StaticFiles
[src]

Called by Rocket when a Request with its associated Data should be handled by this handler. Read more

Auto Trait Implementations

impl Send for StaticFiles

impl Sync for StaticFiles

Blanket Implementations

impl<T> From for T
[src]

Performs the conversion.

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

Performs the conversion.

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

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

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

recently added

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

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

Immutably borrows from an owned value. Read more

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

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

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

Mutably borrows from an owned value. Read more

impl<T> Typeable for T where
    T: Any

Get the TypeId of this object.

impl<F> Handler for F where
    F: 'static + Send + Sync + Clone + for<'r> Fn(&'r Request, Data) -> Outcome<Response<'r>, Status, Data>, 
[src]

Called by Rocket when a Request with its associated Data should be handled by this handler. Read more

impl<T> Cloneable for T where
    T: Handler + Clone
[src]

Clones self.

impl<T> IntoCollection for T

Converts self into a collection.

impl<T, I> AsResult for T where
    I: Input, 

impl<T> IntoSql for T

Convert self to an expression for Diesel's query builder. Read more

Convert &self to an expression for Diesel's query builder. Read more

impl<T> Same for T

Should always be Self

impl<T> Erased for T