Enum zng_wgt_window::SaveState

pub enum SaveState {
    Enabled {
        key: Option<ConfigKey>,
        loading_timeout: Duration,
    },
    Disabled,
}

Window persistence config.

See the save_state property for more details.

Variants

Enabled

Save and restore state.

Fields

key: Option<ConfigKey>

Config key that identifies the window.

If None a key is generated for the window, using the window_key method.

loading_timeout: Duration

Maximum time to keep the window in the loading state awaiting for the config to load.

If the config fails to load in this time frame the window is opened in it’s default state.

This is one second by default.

Disabled

Don’t save nor restore state.

Implementations

impl SaveState

pub fn enabled() -> Self

Default, enabled, no key, delay 1s.

pub fn window_key(&self, id: WindowId) -> Option<ConfigKey>

Gets the config key used for the window identified by id.

pub fn loading_timeout(&self) -> Option<Duration>

Get the loading timeout if it is enabled and the duration is greater than zero.

pub fn is_enabled(&self) -> bool

Returns true if it is enabled.

Trait Implementations

impl Clone for SaveState

fn clone(&self) -> SaveState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SaveState

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

Formats the value using the given formatter.

impl Default for SaveState

fn default() -> Self

Enabled, no key, delay 1s.

impl<'de> Deserialize<'de> for SaveState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<bool> for SaveState

fn from(persist: bool) -> Self

Convert true to default config and false to None.

impl IntoVar<SaveState> for bool

fn into_var(self) -> Self::Var

Convert true to default config and false to None.

type Var = LocalVar<SaveState>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl PartialEq for SaveState

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SaveState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl IntoValue<SaveState> for bool

impl StructuralPartialEq for SaveState