Struct specifications::container::ContainerInfo

pub struct ContainerInfo {

    pub name: String,
    pub version: Version,
    pub kind: PackageKind,
    pub owners: Option<Vec<String>>,
    pub description: Option<String>,
    pub actions: HashMap<String, Action>,
    pub entrypoint: Entrypoint,
    pub types: Option<HashMap<String, Type>>,
    pub base: Option<String>,
    pub dependencies: Option<Vec<String>>,
    pub environment: Option<HashMap<String, String>>,
    pub files: Option<Vec<String>>,
    pub initialize: Option<Vec<String>>,
    pub install: Option<Vec<String>>,
    pub unpack: Option<Vec<String>>,
}

Specifies the contents of a container info YAML file. Note that this is only the file the user creates.

Fields

name: String

The name/programming ID of this package.

version: Version

The version of this package.

kind: PackageKind

The kind of this package.

owners: Option<Vec<String>>

The list of owners of this package.

description: Option<String>

A short description of the package.

actions: HashMap<String, Action>

The functions that this package supports.

entrypoint: Entrypoint

The entrypoint of the image

types: Option<HashMap<String, Type>>

The types that this package adds.

base: Option<String>

The base image to use for the package image.

dependencies: Option<Vec<String>>

The dependencies, as install commands for sudo apt-get install -y <…>

environment: Option<HashMap<String, String>>

Any environment variables that the user wants to be set

files: Option<Vec<String>>

The list of additional files to copy to the image

initialize: Option<Vec<String>>

An extra script to run to initialize the working directory

install: Option<Vec<String>>

An extra set of commands that will be run before the workspace is copied over. Useful for non-standard general dependencies.

unpack: Option<Vec<String>>

An extra set of commands that will be run after the workspace is copied over. Useful for preprocessing or unpacking things.

Implementations

impl ContainerInfo

pub fn from_path<P: AsRef<Path>>( path: P, ) -> Result<ContainerInfo, ContainerInfoError>

Edited: now returning ContainerInfoErrors.

Returns a ContainerInfo by constructing it from the file at the given path.

Generic types

• P: The Path-like type of the given target location.

Arguments

• path: The path to the container info file.

Returns
The newly constructed ContainerInfo instance on success, or a ContainerInfoError upon failure.

pub fn from_reader<R: Read>(r: R) -> Result<ContainerInfo, ContainerInfoError>

Edited: now returning ContainerInfoErrors.

Returns a ContainerInfo by constructing it from the given Reader with YAML text.

Arguments

• r: The reader with the contents of the raw YAML file.

Returns
The newly constructed ContainerInfo instance on success, or a ContainerInfoError upon failure.

pub fn from_string( contents: String, ) -> Result<ContainerInfo, ContainerInfoError>

Edited: now returning ContainerInfoErrors.

Returns a ContainerInfo by constructing it from the given string of YAML text.

Arguments

• contents: The text contents of a raw YAML file.

Returns
The newly constructed ContainerInfo instance on success, or a ContainerInfoError upon failure.

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

Writes the ContainerInfo to the given location.

Generic types

• P: The Path-like type of the given target location.

Arguments

• path: The target location to write to the LocalContainerInfo to.

Returns
Nothing on success, or a ContainerInfoError otherwise.

pub fn to_writer<W: Write>(&self, writer: W) -> Result<(), ContainerInfoError>

Writes the ContainerInfo to the given writer.

Generic types

• W: The type of the writer, which implements Write.

Arguments

• writer: The writer to write to. Will be consumed.

Returns
Nothing on success, or a ContainerInfoError otherwise.

Trait Implementations

impl Clone for ContainerInfo

fn clone(&self) -> ContainerInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContainerInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ContainerInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ContainerInfo> for LocalContainerInfo

fn from(container_info: &ContainerInfo) -> Self

Converts to this type from the input type.

impl From<&ContainerInfo> for PackageInfo

fn from(container: &ContainerInfo) -> Self

Converts to this type from the input type.

impl From<ContainerInfo> for LocalContainerInfo

fn from(container_info: ContainerInfo) -> Self

Converts to this type from the input type.

impl From<ContainerInfo> for PackageInfo

fn from(container: ContainerInfo) -> Self

Converts to this type from the input type.

impl Serialize for ContainerInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.