Struct oci_spec::runtime::Hook

source ·
pub struct Hook { /* private fields */ }
Expand description

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

Implementations§

source§

impl Hook

source

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

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

source§

impl Hook

source

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.

source

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.

source

pub fn env(&self) -> &Option<Vec<String>>

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

source§

impl Hook

source

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.

source

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.

source

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.

source

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.

source§

impl Hook

source

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.

source

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.

source

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.

source

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§

source§

impl Clone for Hook

source§

fn clone(&self) -> Hook

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Hook

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Hook

source§

fn default() -> Hook

Returns the “default value” for a type. Read more
source§

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

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl PartialEq for Hook

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for Hook

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for Hook

source§

impl StructuralPartialEq for Hook

Auto Trait Implementations§

§

impl Freeze for Hook

§

impl RefUnwindSafe for Hook

§

impl Send for Hook

§

impl Sync for Hook

§

impl Unpin for Hook

§

impl UnwindSafe for Hook

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,