Struct specifications::package::PackageInfo

pub struct PackageInfo {
    pub created: DateTime<Utc>,
    pub id: Uuid,
    pub digest: Option<String>,
    pub name: String,
    pub version: Version,
    pub kind: PackageKind,
    pub owners: Vec<String>,
    pub description: String,
    pub detached: bool,
    pub functions: HashMap<String, Function>,
    pub types: HashMap<String, Type>,
}

The PackageInfo struct, which might be used alongside a Docker container to define its metadata.

Fields

created: DateTime<Utc>

The created timestamp of the package.

id: Uuid

The identifier of this package, as an Uuid.

digest: Option<String>

The digest of the resulting image. As long as the image has not been generated, is None.

name: String

The name/programming ID of this package.

version: Version

The version of this package.

kind: PackageKind

The kind of this package.

owners: Vec<String>

The list of owners of this package.

description: String

A short description of the package.

detached: bool

Whether or not the functions in this package run detached (i.e., asynchronous).

functions: HashMap<String, Function>

The functions that this package supports.

types: HashMap<String, Type>

The types that this package adds.

Implementations

impl PackageInfo

pub fn new( name: String, version: Version, kind: PackageKind, owners: Vec<String>, description: String, detached: bool, functions: HashMap<String, Function>, types: HashMap<String, Type>, ) -> PackageInfo

Constructor for the PackageInfo.

Arguments

• name: The name/programming ID of this package.
• version: The version of this package.
• kind: The kind of this package.
• owners: The list of owners of this package.
• description: A short description of the package.
• detached: Whether or not the functions in this package run detached (i.e., asynchronous).
• functions: The functions that this package supports.
• types: The types that this package adds.

pub fn from_path(path: PathBuf) -> Result<PackageInfo, PackageInfoError>

Edited: changed to return appropriate errors. Also added docstring.

Constructor for the PackageInfo that tries to construct it from the file at the given location.

Arguments

• path: The path to load.

Returns
The new PackageInfo upon success, or a PackageInfoError detailling why if it failed.

pub fn from_string(contents: String) -> Result<PackageInfo, PackageInfoError>

Edited: changed to return appropriate errors. Also added docstring.

Constructor for the PackageInfo that tries to deserialize it.

Arguments

• contents: The string that contains the contents for the PackageInfo.

Returns
The new PackageInfo upon success, or a PackageInfoError detailling why if it failed.

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

Writes the PackageInfo 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 PackageInfoError otherwise.

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

Writes the PackageInfo 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 PackageInfoError otherwise.

Trait Implementations

impl Clone for PackageInfo

fn clone(&self) -> PackageInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackageInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackageInfo

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 PackageInfo

fn from(container: &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 PackageInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.