Struct NodeBuilder 

pub struct NodeBuilder { /* private fields */ }

Builder for constructing a Node<TailscaleProvider>.

Configures the Tailscale sidecar, RFC 017 identity, and transport parameters before wiring all layers together.

Example

let node = Node::builder()
    .app_id("playground")?
    .device_name("alice-mbp")
    .sidecar_path("/opt/truffle/sidecar")
    .ws_port(9417)
    .build()
    .await?;

Implementations

impl NodeBuilder

pub fn app_id(self, s: impl Into<String>) -> Result<Self, NodeError>

Set the application namespace identifier (RFC 017 §5.1).

The input is validated against ^[a-z][a-z0-9-]{1,31}$. Invalid values are rejected with NodeError::BuildError.

pub fn device_name(self, s: impl Into<String>) -> Self

Set the human-readable device name.

Accepts any Unicode input; soft-truncated to 256 graphemes. When unset, the builder falls back to hostname::get() at build() time.

pub fn device_id(self, s: impl Into<String>) -> Result<Self, NodeError>

Override the auto-generated device ID.

Validates that s is a well-formed ULID. When provided, the value is persisted to {state_dir}/device-id.txt during build() so subsequent starts without an explicit device_id see it.

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

Set the path to the Go sidecar binary.

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

Set the Tailscale state directory.

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

Set the Tailscale auth key for headless authentication.

pub fn ephemeral(self, val: bool) -> Self

Set whether the node is ephemeral (auto-removed from tailnet on shutdown).

pub fn eager_identity(self, enabled: bool) -> Self

Set the WebSocket listen port. RFC 022 Phase C: when true (default), proactively exchange hello with online peers so durable device_id is learned without app send.

pub fn ws_port(self, port: u16) -> Self

pub fn idle_timeout_secs(self, secs: u64) -> Self

Set the idle timeout (in seconds) for bridged raw TCP connections.

The sidecar reaps quiet bridged connections after this long (default: 600 s). Apps holding long-lived quiet sockets should raise this or send application-level keepalives.

pub async fn build(self) -> Result<Node<TailscaleProvider>, NodeError>

Build and start the node.

This creates the TailscaleProvider, starts it, creates the WebSocket transport and PeerRegistry, starts the session, and spawns the envelope router.

Errors

Returns NodeError::BuildError if required configuration is missing, or propagates errors from the network provider startup.

pub async fn build_with_auth_handler( self, on_auth: impl Fn(String) + Send + 'static, ) -> Result<Node<TailscaleProvider>, NodeError>

Build and start the node, calling on_auth if authentication is needed.

This is identical to build() except it subscribes to provider events before provider.start() blocks, forwarding AuthRequired events to the callback while waiting for authentication to complete.

Errors

Returns NodeError::BuildError if required configuration is missing, or propagates errors from the network provider startup.

Trait Implementations

impl Clone for NodeBuilder

fn clone(&self) -> NodeBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeBuilder

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

Formats the value using the given formatter.

impl Default for NodeBuilder

fn default() -> Self

Returns the “default value” for a type.