Struct PluginInstance

pub struct PluginInstance { /* private fields */ }

An instance of a Plugin, associated with a RequestContext.

Implementations

impl PluginInstance

pub async fn new( plugin: Arc<Plugin>, request_context: RequestContext, ) -> Result<PluginInstance, PluginInstantiationError>

Instantiates a Plugin, creating a new PluginInstance.

Arguments

• plugin - The plugin we are creating a PluginInstance for.
• request_context - The request context stores all of the state associated with an incoming request and its corresponding response.

pub fn stdio(&self) -> PluginStdio

Returns stdout and stderr captured during plugin execution.

pub fn receive_request_body(&self) -> bool

Returns whether this plugin instance expects to process a request body.

pub fn receive_response_body(&self) -> bool

Returns whether this plugin instance expects to process a response body.

pub fn weight(&self) -> f64

Returns the configured weight value for tuning Decision values.

pub fn record_request(&mut self, request: Arc<Request>)

Records a Request so that it will be accessible to the plugin guest environment. Overwrites the existing Request.

pub fn record_response(&mut self, response: Arc<Response>)

Records a Response so that it will be accessible to the plugin guest environment.

pub fn record_combined_decision( &mut self, decision_components: &DecisionComponents, outcome: Outcome, )

Records the combined Decision, it’s tags, and the associated Outcome so that they will be accessible to the plugin guest environment.

pub fn plugin_reference(&self) -> String

Returns the plugin’s identifier.

pub async fn handle_init(&mut self) -> Result<(), PluginExecutionError>

Executes the guest’s init function.

pub async fn handle_request(&mut self) -> Result<(), PluginExecutionError>

Executes the guest’s on_request function.

pub async fn handle_request_decision( &mut self, ) -> Result<(), PluginExecutionError>

Executes the guest’s on_request_decision function.

pub async fn handle_response_decision( &mut self, ) -> Result<(), PluginExecutionError>

Executes the guest’s on_response_decision function.

pub async fn handle_request_body_decision( &mut self, ) -> Result<(), PluginExecutionError>

Executes the guest’s on_request_body_decision function.

pub async fn handle_response_body_decision( &mut self, ) -> Result<(), PluginExecutionError>

Executes the guest’s on_response_body_decision function.

pub async fn handle_decision_feedback( &mut self, ) -> Result<(), PluginExecutionError>

Executes the guest’s on_decision_feedback function.

pub fn decision(&mut self) -> DecisionComponents

Returns the decision components from the RequestContext.