Struct TelemetryConfig 

pub struct TelemetryConfig {
    pub enabled: bool,
    pub installation_id: String,
    pub created_at: i64,
    pub preference_changed_at: Option<i64>,
    pub version: u32,
    pub remote_endpoint: Option<String>,
    pub remote_api_key: Option<String>,
    pub remote_enabled: bool,
}

Telemetry configuration stored on disk

Fields

enabled: bool

Whether telemetry is enabled (opt-in by default)

installation_id: String

Anonymous identifier for this installation

created_at: i64

When the config was first created

preference_changed_at: Option<i64>

When the user last changed their preference

version: u32

Version of the config format

remote_endpoint: Option<String>

Remote telemetry endpoint URL (optional)

remote_api_key: Option<String>

API key for remote endpoint (optional)

remote_enabled: bool

Whether to send telemetry to remote endpoint

Implementations

impl TelemetryConfig

pub fn config_path() -> Result<PathBuf>

Get the path to the telemetry config file

pub fn load() -> Result<Self>

Load telemetry config from disk, creating default if not exists

pub fn save(&self) -> Result<()>

Save telemetry config to disk

pub fn opt_in(&mut self) -> Result<()>

Enable telemetry

pub fn opt_out(&mut self) -> Result<()>

Disable telemetry

pub fn reset_id(&mut self) -> Result<()>

Reset installation ID (generates new anonymous identifier)

pub fn is_enabled(&self) -> bool

Check if telemetry is enabled

pub fn set_remote_endpoint(&mut self, endpoint: Option<String>) -> Result<()>

Configure remote endpoint

pub fn set_remote_api_key(&mut self, api_key: Option<String>) -> Result<()>

Configure remote API key

pub fn set_remote_enabled(&mut self, enabled: bool) -> Result<()>

Enable/disable remote sending

pub fn is_remote_enabled(&self) -> bool

Check if remote telemetry is configured and enabled

Trait Implementations

impl Clone for TelemetryConfig

fn clone(&self) -> TelemetryConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TelemetryConfig

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

Formats the value using the given formatter.

impl Default for TelemetryConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TelemetryConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TelemetryConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.