Struct webthing::action::BaseAction

pub struct BaseAction { /* private fields */ }

Basic action implementation.

An Action represents an individual action which can be performed on a thing.

This can easily be used by other actions to handle most of the boring work.

Implementations

impl BaseAction

pub fn new(
    id: String,
    name: String,
    input: Option<Map<String, Value>>,
    thing: Weak<RwLock<Box<dyn Thing>>>
) -> BaseAction

Create a new BaseAction.

id – ID of this action name – name of the action input – any action inputs

Trait Implementations

impl Action for BaseAction

An Action represents an individual action on a thing.

fn set_href_prefix(&mut self, prefix: String)

Set the prefix of any hrefs associated with this action.

prefix – the prefix

fn get_id(&self) -> String

Get this action’s ID.

fn get_name(&self) -> String

Get this action’s name.

fn get_href(&self) -> String

Get this action’s href.

fn get_status(&self) -> String

Get this action’s status.

fn get_thing(&self) -> Option<Arc<RwLock<Box<dyn Thing>>>>

Get the thing associated with this action.

fn get_time_requested(&self) -> String

Get the time the action was requested.

fn get_time_completed(&self) -> Option<String>

Get the time the action was completed.

fn get_input(&self) -> Option<Map<String, Value>>

Get the inputs for this action.

fn set_status(&mut self, status: String)

Set the status of this action.

status – new status

fn start(&mut self)

Start performing the action.

fn perform_action(&mut self)

Override this with the code necessary to perform the action.

fn cancel(&mut self)

Override this with the code necessary to cancel the action.

fn finish(&mut self)

Finish performing the action.

fn as_action_description(&self) -> Map<String, Value>

Get the action description.