berkus
/
actix-web
mirror of https://github.com/fafhrd91/actix-web
1
0
Fork 0
Code Issues Releases Wiki Activity

docs(files): improve `index_file` docs (#3924)

This commit is contained in:
Yuki Okushi 2026-02-14 20:52:04 +09:00 committed by GitHub
parent f31f9bc92c
commit b1fb44722a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
actix-files/src/files.rs
View File

@ -213,10 +213,14 @@ impl Files {
self
}
/// Set index file
/// Sets index file for directory requests.
///
/// Shows specific index file for directories instead of
/// showing files listing.
/// When a directory is requested, this value is appended to the directory's path on disk.
/// Therefore, the index file path is relative to the served directory (the `serve_from` path
/// passed to [`Files::new`]) and should not include the `serve_from` prefix.
///
/// For example, to serve `./static/index.html` when mounting `Files::new("/", "./static")`,
/// configure it as `.index_file("index.html")` (not `.index_file("./static/index.html")`).
///
/// If the index file is not found, files listing is shown as a fallback if
/// [`Files::show_files_listing()`] is set.