Struct UpdatePrompt 

pub struct UpdatePrompt { /* private fields */ }

The update prompt: what is available, what will happen, and one action.

Implementations

impl UpdatePrompt

pub fn new( updater: Updater, release: Release, cx: &mut Context<'_, Self>, ) -> Self

A prompt offering release.

pub fn auto_restart(self, auto_restart: bool) -> Self

Whether a successful install restarts the app itself (default true). Turn it off to handle UpdatePromptEvent::Installed yourself — the prompt then stays in its installing state, since only the host knows what comes next.

pub fn window_root(self, window_root: bool) -> Self

Whether this prompt is the root view of its own update window: draws the titlebar drag strip and pads for a transparent titlebar. super::open sets it; leave it off when embedding the prompt in a window of your own.

pub fn release(&self) -> &Release

The release being offered.

pub fn busy(&self) -> bool

Whether an install is in flight in this prompt.

pub fn stage(&self) -> Option<&UpdateStage>

The stage the installer is on, if one is running.

pub fn error(&self) -> Option<&str>

Why the last attempt failed, if it did.

pub fn accept(&mut self, cx: &mut Context<'_, Self>)

Take the action the button offers: install in place and restart, or — when this install can’t be rewritten — open the release page and dismiss.

pub fn dismiss(&mut self, cx: &mut Context<'_, Self>)

Give up on the prompt (the “Later” button and Escape). Inert while an install is running, so the progress can’t be dismissed out from under itself.

pub fn set_stage(&mut self, stage: UpdateStage, cx: &mut Context<'_, Self>)

Show a stage without running the installer — for a host driving its own install, and for previewing the states.

pub fn set_failed( &mut self, reason: impl Into<String>, cx: &mut Context<'_, Self>, )

Show a failure without running the installer. The action button becomes “Try Again”.

pub fn reset(&mut self, cx: &mut Context<'_, Self>)

Return to the offer, whatever state the prompt was in.

Trait Implementations

impl EventEmitter<UpdatePromptEvent> for UpdatePrompt

impl Focusable for UpdatePrompt

fn focus_handle(&self, _cx: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for UpdatePrompt

fn render( &mut self, _window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.