Struct State 

pub struct State { /* private fields */ }

State holds information about the runtime state of the container.

Implementations

impl State

pub fn version(&self) -> &String

version is the version of the specification that is supported.

pub fn id(&self) -> &String

id is the container ID

pub fn status(&self) -> &ContainerState

status is the runtime status of the container.

pub fn pid(&self) -> &Option<i32>

pid is the process ID for the container process.

pub fn bundle(&self) -> &PathBuf

bundle is the path to the container’s bundle directory.

pub fn annotations(&self) -> &Option<HashMap<String, String>>

annotations are key values associated with the container.

impl State

pub fn version_mut(&mut self) -> &mut String

version is the version of the specification that is supported.

pub fn id_mut(&mut self) -> &mut String

id is the container ID

pub fn status_mut(&mut self) -> &mut ContainerState

status is the runtime status of the container.

pub fn pid_mut(&mut self) -> &mut Option<i32>

pid is the process ID for the container process.

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

bundle is the path to the container’s bundle directory.

pub fn annotations_mut(&mut self) -> &mut Option<HashMap<String, String>>

annotations are key values associated with the container.

impl State

pub fn set_version(&mut self, val: String) -> &mut Self

version is the version of the specification that is supported.

pub fn set_id(&mut self, val: String) -> &mut Self

id is the container ID

pub fn set_status(&mut self, val: ContainerState) -> &mut Self

status is the runtime status of the container.

pub fn set_pid(&mut self, val: Option<i32>) -> &mut Self

pid is the process ID for the container process.

pub fn set_bundle(&mut self, val: PathBuf) -> &mut Self

bundle is the path to the container’s bundle directory.

pub fn set_annotations( &mut self, val: Option<HashMap<String, String>>, ) -> &mut Self

annotations are key values associated with the container.

impl State

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

Load a State from the provided JSON file path.

Errors

This function will return an OciSpecError::Io if the file does not exist or an OciSpecError::SerDe if the JSON is invalid.

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

Save a State to the provided JSON file path.

Errors

This function will return an OciSpecError::Io if a file cannot be created at the provided path or an OciSpecError::SerDe if the state cannot be serialized.

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 Default for State

fn default() -> State

Returns the “default value” for a type.

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 PartialEq for State

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

Tests for self and other values to be equal, and is used by ==.

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

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

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.

impl Eq for State

impl StructuralPartialEq for State