Struct OtaSettings 

pub struct OtaSettings {
    pub github_token: Option<SecretString>,
}

Configuration for Over-the-Air (OTA) update feature.

Stores the GitHub personal access token required for downloading build artifacts from pull requests.

Security

The GitHub token is stored using SecretString from the secrecy crate, which prevents accidental exposure in logs or debug output. The token is automatically wrapped when loaded from the configuration file and unwrapped only when needed for API authentication.

Fields

github_token: Option<SecretString>

GitHub personal access token with workflow artifact read permissions. Required for authenticated API access to download build artifacts.

When serialized, the token is stored as plain text in the configuration file. However, once loaded into memory, it is wrapped in SecretString to prevent accidental exposure.

For development, you can set the GH_TOKEN environment variable to have it automatically loaded into the default settings.

Trait Implementations

impl Clone for OtaSettings

fn clone(&self) -> OtaSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OtaSettings

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

Formats the value using the given formatter.

impl Default for OtaSettings

fn default() -> Self

Creates a default OtaSettings instance, attempting to read the GitHub token from the GH_TOKEN environment variable. If the variable is set, its value is wrapped in a SecretString and used as the default token.

impl<'de> Deserialize<'de> for OtaSettings

where OtaSettings: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OtaSettings

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.