Struct penguin::Builder

pub struct Builder(_);

Builder for the configuration of Server.

Implementations

impl Builder

pub fn proxy(self, target: ProxyTarget) -> Self

Enables and sets a proxy: incoming requests (that do not match a mount) are forwarded to the given proxy target and its response is forwarded back to the initiator of the request.

Panics if this method is called more than once on a single Builder.

pub fn add_mount(
    self,
    uri_path: impl Into<String>,
    fs_path: impl Into<PathBuf>
) -> Result<Self, ConfigError>

Adds a mount: a directory to be served via file server under uri_path. The order in which the serve dirs are added does not matter. When serving a request, the most specific matching entry “wins”.

This method returns ConfigError::DuplicateUriPath if the same uri_path was added before.

pub fn set_control_path(self, path: impl Into<String>) -> Self

Overrides the control path (/~~penguin by default) with a custom path.

This is only useful if your web application wants to use the route /~~penguin.

pub fn build(self) -> Result<(Server, Controller), ConfigError>

Validates the configuration and builds the server and controller from it. This is a shortcut for Builder::validate plus Server::build.

pub fn validate(self) -> Result<Config, ConfigError>

Validates the configuration and returns the finished Config.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.