Struct AppcastSource 

pub struct AppcastSource { /* private fields */ }

Reads releases from a Sparkle appcast.

The source picks the highest-versioned <item> that applies to the running system, then the best <enclosure> in it for this platform (see os). Items are skipped when they:

• are sparkle:informationalUpdate items (nothing to install);
• are on a sparkle:channel that was not allowed with channel;
• list arm64 in sparkle:hardwareRequirements and the machine cannot run arm64 code;
• fall outside sparkle:minimumSystemVersion / sparkle:maximumSystemVersion (checked on macOS, or wherever a system_version is set);
• have a version that is not a version this crate can order (see AppcastVersion).

The enclosure’s sparkle:edSignature becomes Release::ed25519_signature, so a release verifies against the app’s SUPublicEDKey once it is set as EngineConfig::ed25519_public_key. An optional gpui-updater:sha256 enclosure attribute (namespace https://github.com/AprilNEA/gpui-updater) supplies a checksum for the Checksum and Strict policies.

Phased rollouts, critical updates, sparkle:minimumAutoupdateVersion, and delta enclosures are Sparkle features; this source ignores them and always offers the full archive.

use gpui_updater_core::{AppcastSource, EngineConfig, Verification};

let source = AppcastSource::new("https://dl.example.com/appcast.xml").channel("beta");
let config = EngineConfig::new(Version::new(1, 2, 0))
    .ed25519_public_key("pfIShU4dEXqPd5ObYNfDBiQWcXozk7estwzTnF9BamQ=")
    .verification(Verification::Signature);

Implementations

impl AppcastSource

pub fn new(url: impl Into<String>) -> AppcastSource

Create a source for the appcast at url, matching enclosures for the platform this binary was built for.

pub fn http(self, http: HttpOptions) -> AppcastSource

Fetch the appcast with http’s extra headers and proxy.

pub fn os(self, os: &str) -> AppcastSource

Accept only enclosures whose sparkle:os equals os (case-insensitive). An enclosure without sparkle:os counts as macos, as in Sparkle.

By default the source matches the running platform: on macOS macos; on Windows WinSparkle’s windows-x64 / windows-arm64 / windows-x86, then windows, then enclosures without sparkle:os; on Linux linux-x64 / linux-arm64, then linux. Writing sparkle:os on every enclosure of a shared feed avoids any ambiguity.

pub fn channel(self, channel: impl Into<String>) -> AppcastSource

Also offer items on the sparkle:channel named channel (exact match). Items without a channel are always offered. Call repeatedly to allow several channels.

pub fn version_field(self, field: AppcastVersion) -> AppcastSource

Choose which field holds the version. Defaults to AppcastVersion::ShortVersionString.

pub fn system_version(self, version: Version) -> AppcastSource

Compare sparkle:minimumSystemVersion / sparkle:maximumSystemVersion against version instead of the detected OS version. Without this, the check runs on macOS only (other systems’ versions are not comparable).

pub fn url(&self) -> &str

The appcast URL this source fetches.

Trait Implementations

impl Clone for AppcastSource

fn clone(&self) -> AppcastSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppcastSource

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

Formats the value using the given formatter.

impl UpdateSource for AppcastSource

fn fetch_latest(&self) -> Result<Release, Error>

Fetch the latest release applicable to the running platform.