Struct ServeServiceBuilder

pub struct ServeServiceBuilder<H> { /* private fields */ }

Builder that can be used to run your own serve Service, serving a file or directory, or a placeholder page.

Implementations

impl ServeServiceBuilder<()>

pub fn new() -> Self

Create a new ServeServiceBuilder.

impl<H> ServeServiceBuilder<H>

pub fn concurrent(self, limit: usize) -> Self

set the number of concurrent connections to allow

(0 = no limit)

pub fn set_concurrent(&mut self, limit: usize) -> &mut Self

set the number of concurrent connections to allow

(0 = no limit)

pub fn body_limit(self, limit: usize) -> Self

set the body limit in bytes for each request

pub fn set_body_limit(&mut self, limit: usize) -> &mut Self

set the body limit in bytes for each request

pub fn timeout(self, timeout: Duration) -> Self

set the timeout in seconds for each connection

(0 = no timeout)

pub fn set_timeout(&mut self, timeout: Duration) -> &mut Self

set the timeout in seconds for each connection

(0 = no timeout)

pub fn forward(self, kind: ForwardKind) -> Self

enable support for one of the following “forward” headers or protocols

Supported headers:

Forwarded (“for=”), X-Forwarded-For

X-Client-IP Client-IP, X-Real-IP

CF-Connecting-IP, True-Client-IP

Or using HaProxy protocol.

pub fn set_forward(&mut self, kind: ForwardKind) -> &mut Self

enable support for one of the following “forward” headers or protocols

Same as Self::forward but without consuming self.

pub fn maybe_forward(self, maybe_kind: Option<ForwardKind>) -> Self

maybe enable support for one of the following “forward” headers or protocols.

See Self::forward for more information.

pub fn tls_server_config(self, cfg: ServerConfig) -> Self

define a tls server cert config to be used for tls terminaton by the serve service.

pub fn set_tls_server_config(&mut self, cfg: ServerConfig) -> &mut Self

define a tls server cert config to be used for tls terminaton by the serve service.

pub fn maybe_tls_server_config(self, cfg: Option<ServerConfig>) -> Self

define a tls server cert config to be used for tls terminaton by the serve service.

pub fn http_version(self, version: Version) -> Self

set the http version to use for the http server (auto by default)

pub fn maybe_http_version(self, version: Option<Version>) -> Self

maybe set the http version to use for the http server (auto by default)

pub fn set_http_version(&mut self, version: Version) -> &mut Self

set the http version to use for the http server (auto by default)

pub fn http_layer<H2>(self, layer: H2) -> ServeServiceBuilder<(H, H2)>

add a custom http layer which will be applied to the existing http layers

pub fn content_path(self, path: impl Into<PathBuf>) -> Self

Set the content path to serve (by default it will serve the rama homepage).

pub fn maybe_content_path(self, path: Option<PathBuf>) -> Self

Maybe set the content path to serve (by default it will serve the rama homepage).

pub fn set_content_path(&mut self, path: impl Into<PathBuf>) -> &mut Self

Set the content path to serve (by default it will serve the rama homepage).

pub fn directory_serve_mode(self, mode: DirectoryServeMode) -> Self

Set the DirectoryServeMode which defines how to serve directories.

By default it will use DirectoryServeMode::HtmlFileList.

Note that this is only used in case the content path is defined (e.g. using Self::content_path) and that path points to a valid directory.

pub fn set_directory_serve_mode( &mut self, mode: DirectoryServeMode, ) -> &mut Self

Set the DirectoryServeMode which defines how to serve directories.

By default it will use DirectoryServeMode::HtmlFileList.

Note that this is only used in case the content path is defined (e.g. using Self::content_path) and that path points to a valid directory.

impl<H> ServeServiceBuilder<H>

where H: Layer<Either3<StaticService<Html<&'static str>>, ServeFile, ServeDir>, Service: Service<Request, Response = Response, Error = BoxError>>,

pub fn build( self, executor: Executor, ) -> Result<impl Service<TcpStream, Response = (), Error = Infallible>, BoxError>

build a tcp service ready to serve files

pub fn build_http( &self, ) -> Result<impl Service<Request, Response: IntoResponse, Error = Infallible> + use<H>, BoxError>

build an http service ready to serve files

Trait Implementations

impl<H: Clone> Clone for ServeServiceBuilder<H>

fn clone(&self) -> ServeServiceBuilder<H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H: Debug> Debug for ServeServiceBuilder<H>

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

Formats the value using the given formatter.

impl Default for ServeServiceBuilder<()>

fn default() -> Self

Returns the “default value” for a type.