Struct oci_spec::runtime::HooksBuilder

pub struct HooksBuilder { /* private fields */ }

Builder for Hooks.

Implementations

impl HooksBuilder

pub fn prestart<VALUE: Into<Vec<Hook>>>(self, value: VALUE) -> 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 create_runtime<VALUE: Into<Vec<Hook>>>(self, value: VALUE) -> 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 create_container<VALUE: Into<Vec<Hook>>>(self, value: VALUE) -> 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 start_container<VALUE: Into<Vec<Hook>>>(self, value: VALUE) -> 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 poststart<VALUE: Into<Vec<Hook>>>(self, value: VALUE) -> 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 poststop<VALUE: Into<Vec<Hook>>>(self, value: VALUE) -> Self

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

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

Builds a new Hooks.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for HooksBuilder

fn default() -> Self

Returns the “default value” for a type.