Struct tsnet::ServerBuilder

pub struct ServerBuilder { /* private fields */ }

Server factory, which can be used to configure the properties of a new server.

Methods can be chained on it in order to configure it.

Example

use tsnet::ServerBuilder;

let server = ServerBuilder::new().ephemeral().build().unwrap();

Implementations

impl ServerBuilder

pub fn new() -> ServerBuilder

Generates the base configuration for a new server, from which configuration methods can be chained.

Call ServerBuilder::build to start the server.

pub fn dir(self, dir: PathBuf) -> Self

Specifies the name of the directory to use for state. If unset, a directory is selected automatically under the user’s configuration directory (see https://golang.org/pkg/os/#UserConfigDir), based on the name of the binary.

pub fn hostname(self, hostname: &str) -> Self

The hostname to present to the control server. If unset, the binary name is used.

pub fn authkey(self, authkey: String) -> Self

AuthKey, if set, is the auth key to create the node and will be preferred over the TS_AUTHKEY environment variable. If the node is already created (from state previously stored in in Store), then this field is not used.

pub fn control_url(self, control_url: String) -> Self

Specifies the coordination server URL. If unset, the Tailscale default is used.

pub fn ephemeral(self) -> Self

Specifies that the instance should register as an Ephemeral node (see https://tailscale.com/kb/1111/ephemeral-nodes/)

pub fn redirect_log(self) -> Self

Redirect libtailscale logging to log.

• This starts a new thread to handle logs.
• Everything from libtailscale is logged at INFO level.
• Use an appropriate logger to handle log output further.

pub fn disable_log(self) -> Self

Disable libtailscale logging.

See also ServerBuilder::redirect_log to rely on the Rust log facade.

pub fn build(self) -> Result<Server>

Start the server using the configured options.

Trait Implementations

impl Default for ServerBuilder

fn default() -> ServerBuilder

Returns the “default value” for a type.