Struct PackageSet 

pub struct PackageSet { /* private fields */ }

A Package set brings together a set of package actions, with additional actions such as linking files, adding an env-file, and run before/after script strings.

Implementations

impl PackageSet

pub fn name(&self) -> &Name

Return this package set’s name.

pub fn path(&self) -> &PathBuf

Return the path from which this package set was loaded.

pub fn description(&self) -> &Option<String>

Return the description of this package set, if one has been provided.

pub fn is_platform_match(&self) -> bool

Return true if this package is intended for the current platform, else false.

pub fn platform(&self) -> Platform

Return the platform this package is intended for, None implies all.

pub fn is_optional(&self) -> bool

Return true if this package set is optional, else false.

pub fn env_vars(&self) -> &HashMap<String, String>

Return any environment variables the package set has declared for use in script strings.

pub fn has_actions(&self) -> bool

Return true if this package set has any actions, either package or script string.

pub fn actions(&self) -> &PackageSetActions

Return the actions required by this package set.

pub fn packages(&self) -> Option<impl Iterator<Item = &Package>>

Return all the packages to install for this package set, or None if script strings have been provided instead.

pub fn scripts(&self) -> Option<&HashMap<InstallActionKind, String>>

Return all the script strings to execute for this package set, or None if packages have been provided instead.

pub fn env_file(&self) -> &Option<String>

Return the name of an environment file to link, if one was provided.

pub fn env_file_path(&self) -> Option<PathBuf>

Return the path to the environment file to link, if one was provided.

pub fn link_files(&self) -> &HashMap<String, String>

Return a map of file names to link.

pub fn link_file_paths(&self) -> Vec<(PathBuf, PathBuf)>

Return a map of file path s to link.

pub fn run_before(&self) -> &Option<String>

Return the script string to run before any other action, if one was provided.

pub fn run_after(&self) -> &Option<String>

Return the script string to run after any other action, if one was provided.

Trait Implementations

impl Clone for PackageSet

fn clone(&self) -> PackageSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageSet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackageSet

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PackageSet> for PackageSetBuilder

fn from(package: PackageSet) -> Self

Converts to this type from the input type.

impl From<PackageSetBuilder> for PackageSet

fn from(builder: PackageSetBuilder) -> Self

Converts to this type from the input type.

impl PartialEq for PackageSet

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for PackageSet

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PackageSet