Struct oci_spec::runtime::Hook

pub struct Hook { /* private fields */ }

Hook specifies a command that is run at a particular event in the lifecycle of a container.

Implementations

impl Hook

pub fn timeout(&self) -> Option<i64>

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

impl Hook

pub fn path(&self) -> &PathBuf

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(&self) -> &Option<Vec<String>>

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(&self) -> &Option<Vec<String>>

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

impl Hook

pub fn path_mut(&mut self) -> &mut PathBuf

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_mut(&mut self) -> &mut Option<Vec<String>>

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_mut(&mut self) -> &mut Option<Vec<String>>

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

pub fn timeout_mut(&mut self) -> &mut Option<i64>

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

impl Hook

pub fn set_path(&mut self, val: PathBuf) -> &mut 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 set_args(&mut self, val: Option<Vec<String>>) -> &mut 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 set_env(&mut self, val: Option<Vec<String>>) -> &mut Self

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

pub fn set_timeout(&mut self, val: Option<i64>) -> &mut Self

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

Trait Implementations

impl Clone for Hook

fn clone(&self) -> Hook

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hook

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

Formats the value using the given formatter.

impl Default for Hook

fn default() -> Hook

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Hook

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Hook

fn eq(&self, other: &Hook) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Hook

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Hook

impl StructuralPartialEq for Hook