Struct RequestHandlerOpts

pub struct RequestHandlerOpts {

    pub root_dir: PathBuf,
    pub memory_cache: Option<MemCacheOpts>,
    pub compression: bool,
    pub compression_level: CompressionLevel,
    pub compression_static: bool,
    pub dir_listing: bool,
    pub dir_listing_order: u8,
    pub dir_listing_format: DirListFmt,
    pub dir_listing_download: Vec<DirDownloadFmt>,
    pub cors: Option<Configured>,
    pub security_headers: bool,
    pub cache_control_headers: bool,
    pub page404: PathBuf,
    pub page50x: PathBuf,
    pub page_fallback: Vec<u8>,
    pub basic_auth: String,
    pub index_files: Vec<String>,
    pub log_remote_address: bool,
    pub log_x_real_ip: bool,
    pub log_forwarded_for: bool,
    pub trusted_proxies: Vec<IpAddr>,
    pub redirect_trailing_slash: bool,
    pub ignore_hidden_files: bool,
    pub disable_symlinks: bool,
    pub health: bool,
    pub experimental_metrics: bool,
    pub maintenance_mode: bool,
    pub maintenance_mode_status: StatusCode,
    pub maintenance_mode_file: PathBuf,
    pub advanced_opts: Option<Advanced>,
}

It defines options for a request handler.

Fields

root_dir: PathBuf

Root directory of static files.

memory_cache: Option<MemCacheOpts>

Available on crate feature experimental only.

In-memory cache feature (experimental).

compression: bool

Compression feature.

compression_level: CompressionLevel

Available on crate features compression or compression-gzip or compression-brotli or compression-zstd or compression-deflate only.

Compression level.

compression_static: bool

Compression static feature.

dir_listing: bool

Available on crate feature directory-listing only.

Directory listing feature.

dir_listing_order: u8

Available on crate feature directory-listing only.

Directory listing order feature.

dir_listing_format: DirListFmt

Available on crate feature directory-listing only.

Directory listing format feature.

dir_listing_download: Vec<DirDownloadFmt>

Available on crate feature directory-listing-download only.

Directory listing download feature.

cors: Option<Configured>

CORS feature.

security_headers: bool

Security headers feature.

cache_control_headers: bool

Cache control headers feature.

page404: PathBuf

Page for 404 errors.

page50x: PathBuf

Page for 50x errors.

page_fallback: Vec<u8>

Available on crate feature fallback-page only.

Page fallback feature.

basic_auth: String

Available on crate feature basic-auth only.

Basic auth feature.

index_files: Vec<String>

Index files feature.

log_remote_address: bool

Log remote address feature.

log_x_real_ip: bool

Log the X-Real-IP header.

log_forwarded_for: bool

Log the X-Forwarded-For header.

trusted_proxies: Vec<IpAddr>

Trusted IPs for remote addresses.

redirect_trailing_slash: bool

Redirect trailing slash feature.

ignore_hidden_files: bool

Ignore hidden files feature.

disable_symlinks: bool

Prevent following symlinks for files and directories.

health: bool

Health endpoint feature.

experimental_metrics: bool

Available on Unix and crate feature experimental only.

Metrics endpoint feature (experimental).

maintenance_mode: bool

Maintenance mode feature.

maintenance_mode_status: StatusCode

Custom HTTP status for when entering into maintenance mode.

maintenance_mode_file: PathBuf

Custom maintenance mode HTML file.

advanced_opts: Option<Advanced>

Advanced options from the config file.

Trait Implementations

impl Default for RequestHandlerOpts

fn default() -> Self

Returns the “default value” for a type.