Struct Controller

pub struct Controller { /* private fields */ }

Remote controller for the plugin

Wraps the message-based communication with the plugin into asynchronous functions.

Implementations

impl Controller

pub const fn new(message_tx: MessageSender) -> Self

pub async fn command_replace_config( &self, new_config: Config, ) -> PluginResult<Config>

pub async fn command_switch_state(&self, new_state: State) -> PluginResult<()>

pub async fn command_record_entry( &self, new_entry: Entry, ) -> PluginResult<RecordEntryOutcome>

pub async fn command_shutdown(&self) -> PluginResult<()>

pub async fn query_config(&self) -> PluginResult<Config>

pub async fn query_status(&self, request: StatusRequest) -> PluginResult<Status>

pub async fn query_recent_records( &self, request: RecentRecordsRequest, ) -> PluginResult<Vec<StoredRecord>>

pub async fn query_filter_records( &self, request: FilterRecordsRequest, ) -> PluginResult<Vec<StoredRecord>>

Trait Implementations

impl Clone for Controller

fn clone(&self) -> Controller

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Controller

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

Formats the value using the given formatter.