Struct espresso::config::ServerConfig

pub struct ServerConfig {
    pub address: SocketAddr,
    pub run_dir: PathBuf,
    pub auto_cleanup: Option<bool>,
    pub index_strategy: Option<IndexStrategyConfig>,
    pub redirect_to_slash: Option<bool>,
    pub not_found_path: Option<PathBuf>,
    pub compression: Option<CompressionConfig>,
    pub set_etag: Option<bool>,
    pub set_last_modified: Option<bool>,
    pub mime_disposition: Option<HashMap<String, ContentDispositionConfig>>,
    pub headers: Option<HashMap<String, String>>,
    pub path_configs: Option<Vec<PathConfig>>,
}

Main server configuration.

Fields

address: SocketAddr

Server listed address.

e.g. 127.0.0.1:8080

run_dir: PathBuf

Absolute or relative path to be used as a run directory.

The path will be created if it doesn’t exist.

auto_cleanup: Option<bool>

Whether to allow the Espresso server to automatically clean up the run directory.

This is generally desirable, but can be disbaled for debugging/development.

index_strategy: Option<IndexStrategyConfig>

Specifies how the server should handle directory paths.

redirect_to_slash: Option<bool>

Specifies whether the server redirects directory paths to always end with a slash.

not_found_path: Option<PathBuf>

Specifies the file that the server should return when the specified path can’t be found.

If not specified, the server will return a 404 response with no body.

compression: Option<CompressionConfig>

Specifies what kind of compression will be applied to server responses.

set_etag: Option<bool>

Specifies whether the server should compute ETags and include them in the response.

Note: This only applies to file resources.

set_last_modified: Option<bool>

Specifies whether the server should include a Last-Modified header in responses.

Note: This only applies to file resources.

mime_disposition: Option<HashMap<String, ContentDispositionConfig>>

Optional overrides for the Content-Disposition header on some Mime types.

headers: Option<HashMap<String, String>>

Specifies additional headers to include as part of the response.

path_configs: Option<Vec<PathConfig>>

Path-specific configurations.

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServerConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ServerConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<ServerConfig> for ServerConfig

fn eq(&self, other: &ServerConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ServerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&ServerConfig> for PathContext

type Error = Error

The type returned in the event of a conversion error.

fn try_from(config: &ServerConfig) -> Result<Self, Error>

Performs the conversion.

impl StructuralPartialEq for ServerConfig