Struct oci_spec::runtime::Hooks

pub struct Hooks { /* private fields */ }

Hooks specifies a command that is run in the container at a particular event in the lifecycle (setup and teardown) of a container.

Implementations

impl Hooks

pub fn prestart(&self) -> &Option<Vec<Hook>>

The prestart hooks MUST be called after the start operation is called but before the user-specified program command is executed.

On Linux, for example, they are called after the container namespaces are created, so they provide an opportunity to customize the container (e.g. the network namespace could be specified in this hook).

The prestart hooks’ path MUST resolve in the runtime namespace. The prestart hooks MUST be executed in the runtime namespace.

pub fn create_runtime(&self) -> &Option<Vec<Hook>>

CreateRuntime is a list of hooks to be run after the container has been created but before pivot_root or any equivalent operation has been called. It is called in the Runtime Namespace.

pub fn create_container(&self) -> &Option<Vec<Hook>>

CreateContainer is a list of hooks to be run after the container has been created but before pivot_root or any equivalent operation has been called. It is called in the Container Namespace.

pub fn start_container(&self) -> &Option<Vec<Hook>>

StartContainer is a list of hooks to be run after the start operation is called but before the container process is started. It is called in the Container Namespace.

pub fn poststart(&self) -> &Option<Vec<Hook>>

Poststart is a list of hooks to be run after the container process is started. It is called in the Runtime Namespace.

pub fn poststop(&self) -> &Option<Vec<Hook>>

Poststop is a list of hooks to be run after the container process exits. It is called in the Runtime Namespace.

impl Hooks

pub fn set_prestart(&mut self, val: Option<Vec<Hook>>) -> &mut Self

The prestart hooks MUST be called after the start operation is called but before the user-specified program command is executed.

On Linux, for example, they are called after the container namespaces are created, so they provide an opportunity to customize the container (e.g. the network namespace could be specified in this hook).

The prestart hooks’ path MUST resolve in the runtime namespace. The prestart hooks MUST be executed in the runtime namespace.

pub fn set_create_runtime(&mut self, val: Option<Vec<Hook>>) -> &mut Self

CreateRuntime is a list of hooks to be run after the container has been created but before pivot_root or any equivalent operation has been called. It is called in the Runtime Namespace.

pub fn set_create_container(&mut self, val: Option<Vec<Hook>>) -> &mut Self

CreateContainer is a list of hooks to be run after the container has been created but before pivot_root or any equivalent operation has been called. It is called in the Container Namespace.

pub fn set_start_container(&mut self, val: Option<Vec<Hook>>) -> &mut Self

StartContainer is a list of hooks to be run after the start operation is called but before the container process is started. It is called in the Container Namespace.

pub fn set_poststart(&mut self, val: Option<Vec<Hook>>) -> &mut Self

Poststart is a list of hooks to be run after the container process is started. It is called in the Runtime Namespace.

pub fn set_poststop(&mut self, val: Option<Vec<Hook>>) -> &mut Self

Poststop is a list of hooks to be run after the container process exits. It is called in the Runtime Namespace.

Trait Implementations

impl Clone for Hooks

fn clone(&self) -> Hooks

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hooks

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

Formats the value using the given formatter.

impl Default for Hooks

fn default() -> Hooks

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Hooks

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Hooks

fn eq(&self, other: &Hooks) -> 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 Hooks

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 Hooks

impl StructuralPartialEq for Hooks