Struct ScriptHook 

pub struct ScriptHook { /* private fields */ }

An operator-supplied script, and the budget it runs under.

Implementations

impl ScriptHook

pub fn new(script_path: &str, args: &[String], timeout_ms: u64) -> Option<Self>

Builds a hook, or None when no script is configured.

Each subsystem words its own “you enabled this but gave no path” startup error, because only it knows which configuration key to name and what to tell the operator to remove.

pub fn path(&self) -> &Path

The script’s path, as configured.

pub async fn run( &self, envs: &[(&str, &str)], stdin: ScriptStdin<'_>, ) -> Result<ScriptOutcome, ScriptError>

Runs the script with envs in an otherwise empty environment.

pub fn detail(outcome: &ScriptOutcome, noun: &str) -> String

A one-line reason a script’s non-zero exit should be reported as.

First non-empty line of stdout, else of stderr, else the exit status — prefixed with the stdin failure when there was one, since a script that never received its payload failed for a completely different reason than one that read it and objected.

Trait Implementations

impl Clone for ScriptHook

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptHook

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

Formats the value using the given formatter.