Struct hyper_staticfile::Static
source · pub struct Static {
pub root: PathBuf,
pub cache_headers: Option<u32>,
}Expand description
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.
Note that using the trait currently involves an extra Box.
Fields§
§root: PathBufThe root directory path to serve files from.
cache_headers: Option<u32>Whether to send cache headers, and what lifespan to indicate.
Implementations§
source§impl Static
impl Static
sourcepub fn new(root: impl Into<PathBuf>) -> Self
pub fn new(root: impl Into<PathBuf>) -> Self
Create a new instance of Static with a given root path.
If Path::new("") is given, files will be served from the current directory.
sourcepub fn cache_headers(&mut self, value: Option<u32>) -> &mut Self
pub fn cache_headers(&mut self, value: Option<u32>) -> &mut Self
Add cache headers to responses for the given lifespan.
Trait Implementations§
source§impl<B: Send + Sync + 'static> Service<Request<B>> for Static
impl<B: Send + Sync + 'static> Service<Request<B>> for Static
§type Future = Pin<Box<dyn Future<Output = Result<<Static as Service<Request<B>>>::Response, <Static as Service<Request<B>>>::Error>> + Send>>
type Future = Pin<Box<dyn Future<Output = Result<<Static as Service<Request<B>>>::Response, <Static as Service<Request<B>>>::Error>> + Send>>
Auto Trait Implementations§
impl Freeze for Static
impl RefUnwindSafe for Static
impl Send for Static
impl Sync for Static
impl Unpin for Static
impl UnwindSafe for Static
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit)