Struct PluginEngine

pub struct PluginEngine { /* private fields */ }

Manages a particular query session.

This struct invokes a Query trait object, passing a handle to itself to Query::run(). This allows the query logic to request information from other Hipcheck plugins in order to complete.

Implementations

impl PluginEngine

pub fn mock(mock_responses: MockResponses) -> Self

Available on crate feature mock_engine only.

Constructor for use in unit tests, query() function will reference this map instead of trying to connect to Hipcheck core for a response value

pub fn batch<T>(&mut self, target: T) -> Result<QueryBuilder<'_>>

where T: TryInto<QueryTarget, Error: Into<Error>>,

Convenience function to expose a QueryBuilder to make it convenient to dynamically build up queries to plugins and send them off to the target plugin, in as few GRPC calls as possible

pub async fn query<T, V>(&mut self, target: T, input: V) -> Result<JsonValue>

where T: TryInto<QueryTarget, Error: Into<Error>>, V: Serialize,

Query another Hipcheck plugin target with key input. On success, the JSONified result of the query is returned. target will often be a string of the format "publisher/plugin[/query]", where the bracketed substring is optional if the plugin’s default query endpoint is desired. input must be of a type implementing serde::Serialize,

pub async fn batch_query<T, V>( &mut self, target: T, keys: Vec<V>, ) -> Result<Vec<JsonValue>>

where T: TryInto<QueryTarget, Error: Into<Error>>, V: Serialize,

Query another Hipcheck plugin target with Vec of inputs. On success, the JSONified result of the query is returned. target will often be a string of the format "publisher/plugin[/query]", where the bracketed substring is optional if the plugin’s default query endpoint is desired. keys must be a Vec containing a type which implements serde::Serialize,

pub fn record_concern<S: AsRef<str>>(&mut self, concern: S)

Records a string-like concern that will be emitted in the final Hipcheck report. Intended for use within a Query trait impl.

pub fn get_concerns(&self) -> &[String]

Available on crate feature mock_engine only.

Exposes the current set of concerns recorded by PluginEngine

Trait Implementations

impl Drop for PluginEngine

fn drop(&mut self)

Executes the destructor for this type.

impl From<MockResponses> for PluginEngine

Available on crate feature mock_engine only.

fn from(value: MockResponses) -> Self

Converts to this type from the input type.