Struct HookBuilder

pub struct HookBuilder { /* private fields */ }

Builder for Hook.

Implementations

impl HookBuilder

pub fn path<VALUE: Into<PathBuf>>(self, value: VALUE) -> Self

Path to the binary to be executed. Following similar semantics to IEEE Std 1003.1-2008 execv’s path. This specification extends the IEEE standard in that path MUST be absolute.

pub fn args<VALUE: Into<Vec<String>>>(self, value: VALUE) -> Self

Arguments used for the binary, including the binary name itself. Following the same semantics as IEEE Std 1003.1-2008 execv’s argv.

pub fn env<VALUE: Into<Vec<String>>>(self, value: VALUE) -> Self

Additional key=value environment variables. Following the same semantics as IEEE Std 1003.1-2008’s environ.

pub fn timeout<VALUE: Into<i64>>(self, value: VALUE) -> Self

Timeout is the number of seconds before aborting the hook. If set, timeout MUST be greater than zero.

pub fn build(self) -> Result<Hook, OciSpecError>

Builds a new Hook.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for HookBuilder

fn default() -> Self

Returns the “default value” for a type.