Struct PluginInfoClient 

pub struct PluginInfoClient<Codec = Default> { /* private fields */ }

Remote client for PluginInfo.

Can be sent to a remote endpoint. The only trait that must be implemented by a plugin. It provides lists of stream, filter and action types implemented by a dynamic plugin.

Trait Implementations

impl<Codec> Client for PluginInfoClient<Codec>

where Codec: Codec,

fn capacity(&self) -> usize

Returns the current capacity of the channel for sending requests to the server.

fn closed(&self) -> Closed

Returns a future that completes when the server or client has been dropped or the connection between them has been lost.

fn is_closed(&self) -> bool

Returns whether the server has been dropped or the connection to it has been lost.

fn max_request_size(&self) -> usize

The maximum allowed size of a request in bytes.

fn set_max_request_size(&mut self, max_request_size: usize)

Sets the maximum allowed size of a request in bytes.

fn max_reply_size(&self) -> usize

The maximum allowed size of a reply in bytes.

fn set_max_reply_size(&mut self, max_reply_size: usize)

Sets the maximum allowed size of a reply in bytes.

impl<Codec> Debug for PluginInfoClient<Codec>

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

Formats the value using the given formatter.

impl<'de, Codec> Deserialize<'de> for PluginInfoClient<Codec>

where Codec: Codec,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Codec> Drop for PluginInfoClient<Codec>

fn drop(&mut self)

Executes the destructor for this type.

impl<Codec> PluginInfo for PluginInfoClient<Codec>

where Codec: Codec,

async fn manifest(&mut self) -> Result<Manifest, CallError>

Return the manifest of the plugin. This should not be dynamic, and return always the same manifest.

async fn load_config( &mut self, streams: Vec<StreamConfig>, actions: Vec<ActionConfig>, ) -> RemoteResult<(Vec<StreamImpl>, Vec<ActionImpl>)>

Load all plugin stream and action configurations. Must error if config is invalid.

async fn start(&mut self) -> RemoteResult<()>

Notify the plugin that setup is finished, permitting a last occasion to report an error that’ll make reaction exit. All initialization (opening remote connections, starting streams, etc) should happen here.

async fn close(self) -> RemoteResult<()>

Notify the plugin that reaction is quitting and that the plugin should quit too. A few seconds later, the plugin will receive SIGTERM. A few seconds later, the plugin will receive SIGKILL.

impl<Codec> Serialize for PluginInfoClient<Codec>

where Codec: Codec,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.