rwf2
/
Rocket
mirror of https://github.com/rwf2/Rocket.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve docs for 'Options::NormalizeDirs'.

This commit is contained in:
Sergio Benitez 2020-05-30 01:40:39 -07:00
parent c3187bfe91
commit 6a1e4c668c
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
contrib/lib/src/serve.rs
View File

@ -28,6 +28,8 @@ use rocket::response::{NamedFile, Redirect};
/// * [`Options::None`] - Return only present, visible files.
/// * [`Options::DotFiles`] - In addition to visible files, return dotfiles.
/// * [`Options::Index`] - Render `index.html` pages for directory requests.
/// * [`Options::NormalizeDirs`] - Redirect directories without a trailing
/// slash to ones with a trailing slash.
///
/// `Options` structures can be `or`d together to select two or more options.
/// For instance, to request that both dot files and index pages be returned,
@ -38,8 +40,8 @@ pub struct Options(u8);
#[allow(non_upper_case_globals, non_snake_case)]
impl Options {
/// `Options` representing the empty set. No dotfiles or index pages are
/// rendered. This is different than the [`Options::default()`], which
/// enables `Index`.
/// rendered. This is different than [`Options::default()`](#impl-Default),
/// which enables `Index`.
pub const None: Options = Options(0b0000);
/// `Options` enabling responding to requests for a directory with the