Struct PluginEnv

#[repr(C)]
pub struct PluginEnv(/* private fields */);

A companion structure, always passed as first argument of any plugin operation function, enabling the plugin to interact with the host implementation.

Implementations

impl PluginEnv

pub fn save_output(&self, v: PluginVal) -> Result<()>

Store a new plugin output.

pub fn save_outputs(&self, v: &[PluginVal]) -> Result<()>

Store all the plugin outputs.

pub fn print(&self, s: &str)

Print the provided string on the standard output.

pub fn get_connection<T>(&self, field: ConnectionField) -> Result<T>

where T: TryFrom<PluginVal>,

Get a connection field.

pub fn set_connection<T>(&mut self, field: ConnectionField, v: T) -> Result<()>

where T: Into<PluginVal>,

Set a connection field.

pub fn get_recovery<'de, T>(&self, field: RecoveryField) -> T

where T: Deserialize<'de>,

Get a recovery field.

pub fn set_recovery<T>(&mut self, field: RecoveryField, v: T) -> Result<()>

where T: Into<PluginVal>,

Set a recovery field.

pub fn get_input<T>(&self, index: u32) -> Result<T>

where T: TryFrom<PluginVal>, <T as TryFrom<PluginVal>>::Error: Debug,

Get an input.

pub fn get_inputs(&self) -> Result<Vec<PluginVal>>

Get the inputs.

pub fn get_bytes(&mut self, tag: u64, len: u64) -> Result<Vec<u8>>

Read some bytes and advances the related buffer (i.e., multiple calls give different results).

pub fn put_bytes(&mut self, tag: u64, b: &[u8]) -> Result<usize>

Write some bytes and advances the related buffer (i.e., multiple calls gives different results).

pub fn register(&mut self, r: Registration) -> Result<()>

Perform a registration to the host implementation. This operation is usually performed during the initialization of the plugin.

pub fn set_timer( &mut self, ts: UnixInstant, id: u64, timer_id: u64, ) -> Result<()>

Set a timer at the provided time to call the given callback function with the provided name.

Returns the identifier to the timer event, as provided as argument.

pub fn cancel_timer(&mut self, id: u64) -> Result<()>

Cancel the timer event having the identifier provided.

pub fn get_unix_instant(&self) -> Result<UnixInstant>

Get the current UNIX instant.

pub fn enable(&self)

Fully enable the plugin operations. Such a call is needed to enable plugin operations that are not always_enabled().

pub fn poctl(&mut self, id: u64, params: &[PluginVal]) -> Result<Vec<PluginVal>>

Invoke a plugin operation control operation.