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: &Utf8Path ) -> Utf8PathBuf

The path of a package once it is built.

pub fn get_stamped_output_path( &self, name: &str, output_directory: &Utf8Path ) -> Utf8PathBuf

The path of a package after it has been “stamped” with a version.

pub fn get_output_file(&self, name: &str) -> String

The filename of a package once it is built.

pub async fn create_for_target( &self, target: &Target, name: &str, output_directory: &Utf8Path ) -> Result<File>

👎Deprecated: Use ‘Package::create’, which now takes a ‘BuildConfig’, and implements ‘Default’

pub async fn create( &self, name: &str, output_directory: &Utf8Path, build_config: &BuildConfig<'_> ) -> Result<File>

pub async fn stamp( &self, name: &str, output_directory: &Utf8Path, version: &Version ) -> Result<Utf8PathBuf>

pub async fn create_with_progress_for_target( &self, progress: &impl Progress, target: &Target, name: &str, output_directory: &Utf8Path ) -> Result<File>

👎Deprecated: Use ‘Package::create’, which now takes a ‘BuildConfig’, and implements ‘Default’

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

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a copy of the value.

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

Performs copy-assignment from source.

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.

impl PartialEq for Package

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Package