Struct UpdateConfig 

pub struct UpdateConfig { /* private fields */ }

Everything the blocking check and install need, and nothing that can’t cross onto a background thread. Build one through Updater unless you are driving the mechanics yourself.

Implementations

impl UpdateConfig

pub fn new( app: impl Into<String>, version: impl Into<String>, source: UpdateSource, ) -> Self

A config for app at version, checking source.

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

The codesign requirement a macOS update must satisfy before it is installed — without this, macOS installs refuse to run in place and the prompt falls back to opening the download page.

Pass the requirement text only; the -R= that codesign needs is added here. Pin your team, not a certificate: team IDs survive certificate renewals, so

.codesign_requirement("anchor apple generic and certificate leaf[subject.OU] = XJDC46F35X")

keeps working when the signing cert rolls. The practical consequence is that an ad-hoc signed build — what CI produces when the signing secrets are absent — cannot self-update, and shouldn’t be able to.

pub fn require_checksum(self, require: bool) -> Self

Refuse to install an update whose release publishes no SHA-256.

A published digest is always checked when it exists. This turns a missing one from a silent pass into a refusal, which is the setting you want on Linux: the AppImage path has no signature to fall back on, so without a digest the only thing vouching for the file that is about to be renamed over the running binary is the feed that named it.

Publish <asset>.sha256 beside each artifact, or a SHA256SUMS listing, and turn this on.

pub fn requires_checksum(&self) -> bool

Whether a missing checksum blocks an install.

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

Override the User-Agent sent with every request.

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

Override the filesystem-safe name used for staging paths.

pub fn app(&self) -> &str

The app’s display name.

pub fn version(&self) -> &str

The running version.

pub fn source(&self) -> &UpdateSource

Where releases are published.

pub fn install_kind(&self) -> InstallKind

How this copy was installed — see super::detect.

pub fn check(&self) -> Result<UpdateCheck, String>

Fetch the latest release and classify it. Blocking (it spawns curl) — run it on gpui’s background executor, or let super::start and super::check_now do that for you.

pub fn install( &self, release: &Release, kind: &InstallKind, on_stage: &dyn Fn(UpdateStage), ) -> Result<Relaunch, String>

Download the release and rewrite this install in place, returning how to relaunch. Blocking — run it off the UI thread. on_stage is called from the calling thread as the install progresses, including once per download sample.

pub fn can_install(&self, release: &Release, kind: &InstallKind) -> bool

Whether this release can be installed in place — the question the prompt’s action button asks before it promises anything.

All three halves matter. The install has to be one we can rewrite; the release has to have published the asset to do it with (a release still uploading its artifacts hasn’t); and a macOS install needs a codesign_requirement to verify the payload against. Any of them missing and the honest button is “Open Download”.

Trait Implementations

impl Clone for UpdateConfig

fn clone(&self) -> UpdateConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateConfig

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

Formats the value using the given formatter.

impl Eq for UpdateConfig

impl PartialEq for UpdateConfig

fn eq(&self, other: &UpdateConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for UpdateConfig