Struct LocalServerBuilder

pub struct LocalServerBuilder { /* private fields */ }

Available on crate feature local-server only.

Builder for a server that binds on a random port on localhost and waits for a GET HTTP request.

The server is spawned when calling LocalServerBuilder::spawn().

The query string of the URI where the end-user is redirected is available by .awaiting the LocalServerRedirectHandle, in case it should receive parameters.

The server is shutdown when LocalServerRedirectHandle is dropped. It can also be shutdown manually with a LocalServerShutdownHandle obtained from LocalServerRedirectHandle::shutdown_handle().

Implementations

impl LocalServerBuilder

pub fn new() -> Self

Construct a LocalServerBuilder using the default settings.

pub fn ip_address(self, ip_address: LocalServerIpAddress) -> Self

Set the IP address that the server should to bind to.

Defaults to LocalServerIpAddress::LocalhostAny.

pub fn port_range(self, range: Range<u16>) -> Self

The default range of ports the server will try to bind to randomly.

Care should be taken not to bind to a port blocked by browsers.

Defaults to ports in the 20000..30000 range.

pub fn bind_tries(self, tries: u8) -> Self

The number of times the server will try to bind to a random port on localhost.

Since random ports might already be taken, this setting allows to try to bind to several random ports before giving up.

Defaults to 10.

pub fn response(self, response: LocalServerResponse) -> Self

Set the content of the page that the end user will see when they a redirected to the server’s URI.

Defaults to a plain text page with a generic message.

pub async fn spawn(self) -> Result<(Url, LocalServerRedirectHandle), Error>

Spawn the server.

Returns the Url where the server is listening, and a LocalServerRedirectHandle to await the redirect or to shutdown the server. Returns an error if the server could not be bound to a port on localhost.

Trait Implementations

impl Clone for LocalServerBuilder

fn clone(&self) -> LocalServerBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalServerBuilder

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

Formats the value using the given formatter.

impl Default for LocalServerBuilder

fn default() -> LocalServerBuilder

Returns the “default value” for a type.