Struct SaveStatusSurface 

pub struct SaveStatusSurface { /* private fields */ }

A document’s save status, in the window’s bar (see the module).

Implementations

impl SaveStatusSurface

pub fn new() -> SaveStatusSurface

pub fn set(&mut self, state: SaveState, now: Instant) -> bool

Report the save state. A change says it; the same state again does nothing, so calling this every frame is fine. Returns whether what the surface says changed.

pub fn state(&self) -> Option<&SaveState>

The save state last reported, for an app’s accessibility status and automation.

pub fn advance(&mut self, now: Instant) -> bool

Move an unconfirmed save along at now: “Retrying…” (asking for a submission) past SAVE_STALL, “Not saved” past SAVE_GIVE_UP, and let a passing notice go once its time is up. Returns whether what the surface says changed.

pub fn seen(&mut self)

The window was seen (it drew a frame): a save that gave up is said in place, and a notification about it would only repeat it.

pub fn take_retry(&mut self) -> bool

Whether the surface asked for the record’s changes to be submitted again (a save that stalled), once. A host routes it like SaveAction::Retry.

pub fn take_bar_action(&mut self) -> Option<SaveAction>

“Try again” pressed beside the save’s notice in the window’s bar, once: the host submits the changes again. A save that gave up waits afresh.

pub fn take_notice( &mut self, now: Instant, document: Option<&str>, app: &str, ) -> Option<SaveNotice>

A notification to raise about a save that gave up while nobody saw the window, once, at now. It names the document (its title, if it has one) and says the changes are still in app, since whoever reads it is somewhere else. The host posts it and routes its action to Self::retry_from_notice; Self::take_withdrawal says when to take it down.

pub fn take_withdrawal(&mut self) -> bool

Whether a notification Self::take_notice raised should come down (the save landed or failed differently, the person tried again, or the window is in view again and says it in place), once.

pub fn retry_from_notice(&mut self)

“Try again” from the notification Self::take_notice raised: the host submits the changes again and the wait starts over.

pub fn shows_unsaved(&self) -> bool

Whether the document has work the window should mark unsaved (crate::window_toolbar::ToolbarLocation::edited): a save that failed, or one still unconfirmed past SAVE_STALL. A save that lands in time marks nothing, as it says nothing.

pub fn gave_up(&self) -> bool

Whether the current save gave up waiting and asks the person.

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

The reason of the failure that stands, if any.

pub fn notice(&self) -> Option<ToolbarNotice>

What the window’s bar says of the save, if anything: a failure or a save that gave up, held with “Try again”, or a passing “Saved” or “Retrying…”.

pub fn publish(&self)

Keep the window’s bar saying the save’s notice while there is one, and take it down once there is not; call on every sync. A notice shown since from elsewhere in the window stays.

pub fn needs_publish(&self) -> bool

Whether the window’s bar says something other than the save’s notice now: a passing notice whose time is over is still up until the next Self::publish. A widget whose sync runs only on a reported change reports one while this holds.

pub fn next_wake_deadline(&self) -> Option<Instant>

When the surface next moves along by itself: a passing notice’s end, or an unconfirmed save’s next stage. A held notice waits for the person.

Trait Implementations

impl Debug for SaveStatusSurface

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

Formats the value using the given formatter.

impl Default for SaveStatusSurface

fn default() -> SaveStatusSurface

Returns the “default value” for a type.

impl Drop for SaveStatusSurface

A save status gone with its window leaves the window’s bar with it.

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.