Struct SubprocessPlugin 

pub struct SubprocessPlugin;

The factory a configuration reaches through plugin: subprocess.

Implementations

impl Plugin

pub fn build_from_document( &self, name: &SourceName, config: &Value, secrets: &dyn SecretResolver, document_dir: Option<&Path>, ) -> Result<Box<dyn TaskSource>, SourceError>

SourcePlugin::build, telling the child which document supplied its settings.

document_dir is SourceConfig::document_dir: the engine reaches this rather than the trait method because the trait hands a plugin values and no origins, and this plugin alone passes an origin on — as document_dir in the handshake (docs/plugin-protocol.md §3).

Errors

What SourcePlugin::build returns.

Trait Implementations

impl Clone for Plugin

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Plugin

impl Debug for Plugin

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

Formats the value using the given formatter.

impl Default for Plugin

fn default() -> Self

Returns the “default value” for a type.

impl SourcePlugin for Plugin

fn kind(&self) -> &'static str

The name a configuration document’s plugin: field names.

fn config_schema(&self) -> Schema

The JSON Schema for this plugin’s own config: block.

fn build( &self, name: &SourceName, config: &Value, secrets: &dyn SecretResolver, ) -> Result<Box<dyn TaskSource>, SourceError>

Build a live source from one configuration block.

fn build_with_clock( &self, name: &SourceName, config: &Value, secrets: &dyn SecretResolver, clock: Arc<dyn Clock>, ) -> Result<Box<dyn TaskSource>, SourceError>

Build a live source from one configuration block, handing it the clock it paces and backs off on.

fn document_relative_paths(&self) -> &'static [&'static str]

The fields of this plugin’s config: block that name a filesystem path, as dotted paths into that block.