Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

ClientBuilder provides configures and builds a iroh-services client, typically created with Client::builder

Implementations

impl ClientBuilder

pub fn new(endpoint: &Endpoint) -> Self

pub fn register_metrics_group( self, metrics_group: Arc<dyn MetricsGroup>, ) -> Self

Register a metrics group to forward to iroh-services

The default registered metrics uses only the endpoint

pub fn metrics_interval(self, interval: Duration) -> Self

Set the metrics collection interval

Defaults to enabled, every 60 seconds.

pub fn disable_metrics_interval(self) -> Self

Disable metrics collection.

pub fn name(self, name: impl Into<String>) -> Result<Self>

Set an optional human-readable name for the endpoint, making its metrics easier to identify.

Often a database user id, machine name, or other stable identifier from your application. A name must be 2 to 128 bytes of UTF-8; uniqueness is not enforced, so different endpoints may share a name.

Validation errors are returned here. The name is sent to the server after the client authenticates; a failure to send it at that point is logged at warn level rather than returned; use Client::set_name to set it later with explicit error handling.

pub fn group(self, group: impl Into<String>) -> Result<Self>

Attach the endpoint to a single named group when the client first authenticates.

A group name must be 2 to 128 bytes of UTF-8. Validation errors are returned here. The group is sent to the server after the client authenticates; a failure to send it at that point is logged at warn level rather than returned; use Client::set_group to set it later with explicit error handling.

pub fn attributes<I, K, V>(self, attrs: I) -> Result<Self>

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Attach arbitrary key-value attributes to the endpoint when the client first authenticates. Accepts any iterable of (key, value) pairs:

let _ = Client::builder(endpoint).attributes([("env", "prod"), ("region", "us-west")])?;

Each key must be 2 to 128 bytes of UTF-8; values may be empty and are capped at 128 bytes; at most 128 entries are allowed. Validation errors are returned here. The attributes are sent to the server after the client authenticates; a failure to send them at that point is logged at warn level rather than returned; use Client::set_attributes to set them later with explicit error handling.

pub fn api_secret_from_env(self) -> Result<Self>

Check IROH_SERVICES_API_SECRET environment variable for a valid API secret

pub fn api_secret_from_str(self, secret_key: &str) -> Result<Self>

set client API secret from an encoded string

pub fn api_secret(self, ticket: ApiSecret) -> Result<Self>

Use a shared secret & remote iroh-services endpoint ID contained within a ticket to construct a iroh-services client. The resulting client will have “Client” capabilities.

API secrets include remote details within them, and will set both the remote and rcan values on the builder

pub async fn ssh_key_from_file<P: AsRef<Path>>(self, path: P) -> Result<Self>

Loads the private ssh key from the given path, and creates the needed capability.

The file must contain an unencrypted PEM-encoded OpenSSH ed25519 private key.

pub fn ssh_key(self, pem: &str) -> Result<Self>

Creates the capability from the provided PEM-encoded OpenSSH ed25519 private key.

pub fn rcan(self, cap: Rcan<Caps>) -> Result<Self>

Sets the rcan directly.

pub fn remote(self, remote: impl Into<EndpointAddr>) -> Self

Sets the remote to dial, must be provided either directly by calling this method, or through calling the api_secret builder methods.

pub async fn build(self) -> Result<Client, BuildError>

Create a new client, connected to the provide service node