Struct omicron_zone_package::package::Package

pub struct Package {
    pub service_name: String,
    pub source: PackageSource,
    pub output: PackageOutput,
    pub only_for_targets: Option<BTreeMap<String, String>>,
    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.

source: PackageSource

Identifies from where the package originates.

For example, do we need to assemble it ourselves, or pull it from somewhere else?

output: PackageOutput

Identifies what the output of the package should be.

only_for_targets: Option<BTreeMap<String, String>>

Identifies the targets for which the package should be included.

If ommitted, the package is assumed to be included for all targets.

setup_hint: Option<String>

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

Implementations

impl Package

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

pub async fn create(&self, name: &str, 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,
    name: &str,
    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.