Struct TelemetryContextBuilder 

pub struct TelemetryContextBuilder { /* private fields */ }

Builder for TelemetryContext.

Implementations

impl TelemetryContextBuilder

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

Set the owning tool’s name. Required.

pub fn tool_version(self, version: impl Into<String>) -> Self

Set the tool’s version string. Required.

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

Set the per-tool salt used in MachineId::derive. Required when policy == Enabled; ignored otherwise.

Correctness

The salt must be unique and stable per tool, otherwise two tools running on the same host will emit identical machine IDs and become indistinguishable in the telemetry backend. A failing pattern is passing a literal like "default" from every tool’s codebase — don’t do that.

The recommended pattern is to derive the salt from the tool’s name and a fixed version tag, e.g.:

.salt(concat!(env!("CARGO_PKG_NAME"), ".telemetry.v1"))

Rotating the version tag (.v1 → .v2) invalidates every previously-recorded machine identity — the intended path for “reset my telemetry identity” flows.

pub fn sink(self, sink: Arc<dyn TelemetrySink>) -> Self

Set the backing sink. Defaults to NoopSink.

pub const fn policy(self, policy: CollectionPolicy) -> Self

Set the collection policy. Default is CollectionPolicy::Disabled — opt-in.

pub fn build(self) -> TelemetryContext

Finalise the context.

Panics

Panics if tool, tool_version, or (when policy == Enabled) salt were not supplied. Panic message names the missing field.

Trait Implementations

impl Default for TelemetryContextBuilder

fn default() -> TelemetryContextBuilder

Returns the “default value” for a type.