Struct gstore::Action

pub struct Action { /* private fields */ }

An Action describes a mutation of the global state.

It has a name which is used for pattern matching and a payload. Since gstore is for the GTK framework these actions are linked to GTK Actions. GTK Actions use their own ‘generic value type’ called Variant. Thus gstore Actions have a Variant as argument.

Examples

// given we receive an action `action` in a reducer
// Note: Action::new is not public
let action = Action::new("test".into(), Some(128_i32.to_variant()))
// get a rust value from it by using
if let Some(number) = action.arg::<i32>() {
    // do stuff
}

Implementations

impl Action

pub fn name(&self) -> &str

Get the name of the action

pub fn argument(&self) -> Option<String>

Create a new action.

NOTE:

This is a placeholder since rustdoc server can not compile latest gtk yet The actual signature looks like this:

pub fn argument(&self) -> Option<&glib::Variant>

pub fn arg<T: Sized>(&self) -> Option<String>

Try to get the argument as . If either there is no argument or the argument is of a different type, the returned Option will be None.

NOTE:

This is a placeholder since rustdoc server can not compile latest gtk yet The actual signature looks like this:

pub fn arg<T: glib::FromVariant + Sized>(&self) -> Option<T>

Trait Implementations

impl Clone for Action

fn clone(&self) -> Action

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Action

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

Formats the value using the given formatter.

impl Display for Action

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

Formats the value using the given formatter.