Struct State 

pub struct State {
    pub oci_version: String,
    pub id: String,
    pub status: Status,
    pub pid: Option<u32>,
    pub bundle: PathBuf,
    pub annotations: HashMap<String, String>,
}

OCI container state.

This is the state structure as defined by the OCI runtime specification. It is passed to hooks via stdin and returned by the state command.

Fields

oci_version: String

OCI specification version.

id: String

Container ID (unique identifier).

status: Status

Container status.

pid: Option<u32>

Process ID of the container’s init process (if running).

bundle: PathBuf

Absolute path to the bundle directory.

annotations: HashMap<String, String>

Annotations from the container configuration.

Implementations

impl State

pub fn new(id: String, bundle: PathBuf) -> Self

Create a new container state.

pub fn with_generated_id(bundle: PathBuf) -> Self

Create a new container state with generated ID.

pub fn load<P: AsRef<Path>>(path: P) -> Result<Self>

Load state from JSON file.

pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save state to JSON file.

pub fn to_json(&self) -> Result<String>

Convert to JSON string.

pub const fn set_pid(&mut self, pid: u32)

Set the container PID.

pub const fn clear_pid(&mut self)

Clear the container PID.

pub fn transition_to(&mut self, new_status: Status) -> Result<()>

Transition to a new status.

Returns an error if the transition is invalid.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for State

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for State

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

where __S: Serializer,

Serialize this value into the given Serde serializer.