Struct ServerBuilder

pub struct ServerBuilder { /* private fields */ }

A builder struct for starting a test Server.

Implementations

impl ServerBuilder

pub fn new(extensions: Extensions, options: Options) -> Self

Creates a new builder with extensions and options, with HTTPS enabled. To disable this, call Self::http. Use Self::default() for a default configuration.

Also see the From implementations for this struct.

The inner Extensions can be modified with Self::with_extensions and the host::Options with Self::with_options

pub fn http(self) -> Self

Disables HTTPS.

pub fn with_extensions(self, mutation: impl Fn(&mut Extensions)) -> Self

Modifies the internal Extensions with mutation. If you already have a Extensions, use From.

pub fn with_options(self, mutation: impl Fn(&mut Options)) -> Self

Modifies the internal host::Options with mutation. If you already have a host::Options, use From.

pub fn path(self, path: impl AsRef<str>) -> Self

Sets the Host::path of this server.

pub fn enable_handover(self, path: impl AsRef<Path>) -> Self

Enables handover for this server. If you are starting the server which will take over the requests, use Self::handover_from instead. The communication socket is at path.

pub fn handover_from(self, previous: &Server) -> Self

“Steals” the requests from previous.

Panics

Will panic if Self::enable_handover wasn’t called on previous’s ServerBuilder.

pub async fn run(self) -> Server

Starts a Kvarn server with the current configuraion.

The returned Server can make requests to the server, streamlining the process of testing Kvarn.

Trait Implementations

impl Default for ServerBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<(Extensions, Options)> for ServerBuilder

fn from(data: (Extensions, Options)) -> Self

Converts to this type from the input type.

impl From<Extensions> for ServerBuilder

fn from(extensions: Extensions) -> Self

Converts to this type from the input type.

impl From<Options> for ServerBuilder

fn from(options: Options) -> Self

Converts to this type from the input type.