Struct omicron_zone_package::package::Package

pub struct Package {
    pub service_name: String,
    pub blobs: Option<Vec<PathBuf>>,
    pub rust: Option<RustPackage>,
    pub paths: Vec<MappedPath>,
    pub zone: bool,
    pub setup_hint: Option<String>,
}

A single package.

Fields

service_name: String

The name of the service name to be used on the target OS.

blobs: Option<Vec<PathBuf>>

A list of blobs from the Omicron build S3 bucket which should be placed within this package.

rust: Option<RustPackage>

Configuration for packages containing Rust binaries.

paths: Vec<MappedPath>

A set of mapped paths which appear within the archive.

zone: bool

Identifies if the package should be packaged into a zone image.

setup_hint: Option<String>

A human-readable string with suggestions for setup if packaging fails.

Implementations

impl Package

pub fn get_output_path(&self, output_directory: &Path) -> PathBuf

pub async fn create(&self, output_directory: &Path) -> Result<File>

Constructs the package file in the output directory.

pub fn get_total_work(&self) -> u64

Returns the “total number of things to be done” when constructing a package.

This is intentionally vaguely defined, but it intended to be a rough indication of progress when using Self::create_with_progress.

pub async fn create_with_progress(
    &self,
    progress: &impl Progress,
    output_directory: &Path
) -> Result<File>

Identical to Self::create, but allows a caller to receive updates about progress while constructing the package.

Trait Implementations

impl Debug for Package

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Package

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.