Struct PackageInfo

pub struct PackageInfo {

    pub auth: String,
    pub delete_obsolete_languages: Option<bool>,
    pub follow_symlinks: Option<bool>,
    pub format_version: u8,
    pub generator_version: Option<String>,
    pub identifier: String,
    pub install_location: Option<String>,
    pub minimum_system_version: Option<bool>,
    pub overwrite_permissions: Option<bool>,
    pub postinstall_action: Option<String>,
    pub preserve_xattr: Option<bool>,
    pub relocatable: Option<bool>,
    pub use_hfs_plus_compression: Option<bool>,
    pub version: String,
    pub atomic_update_bundle: Vec<BundleRef>,
    pub bundle: Vec<Bundle>,
    pub bundle_version: Vec<BundleRef>,
    pub dont_obsolete: Vec<File>,
    pub install_at_startup: Vec<File>,
    pub patch: Vec<File>,
    pub payload: Option<Payload>,
    pub relocate: Vec<BundleRef>,
    pub scripts: Scripts,
    pub strict_identifiers: Vec<BundleRef>,
    pub update_bundle: Vec<BundleRef>,
    pub upgrade_bundle: Vec<BundleRef>,
}

Provides information about the package to install.

This includes authentication requirements, behavior after installation, etc. See the fields for more descriptions.

Fields

auth: String

Authentication requirements for the package install.

Values include none and root.

delete_obsolete_languages: Option<bool>

follow_symlinks: Option<bool>

Whether symlinks found at install time should be resolved instead of being replaced by a real file or directory.

format_version: u8

Format version of the package.

Value is likely 2.

generator_version: Option<String>

Identifies the tool that assembled this package.

identifier: String

Uniform type identifier that defines the package.

Should ideally be unique to this package.

install_location: Option<String>

Default location where the payload hierarchy should be installed.

minimum_system_version: Option<bool>

Defines minimum OS version on which the package can be installed.

overwrite_permissions: Option<bool>

Defines if permissions of existing directories should be updated with ones from the payload.

postinstall_action: Option<String>

Action to perform after install.

Potential values can include logout, restart, and shutdown.

preserve_xattr: Option<bool>

Preserve extended attributes on files.

relocatable: Option<bool>

Unknown.

Probably has something to do with whether the installation tree can be relocated without issue.

use_hfs_plus_compression: Option<bool>

Whether items in the package should be compressed after installation.

version: String

Version of the package.

This is the version of the package itself, not the version of the application being installed.

atomic_update_bundle: Vec<BundleRef>

bundle: Vec<Bundle>

Versioning information about bundles within the payload.

bundle_version: Vec<BundleRef>

dont_obsolete: Vec<File>

Files to not obsolete during install.

install_at_startup: Vec<File>

Installs to process at next startup.

patch: Vec<File>

Files to be patched.

payload: Option<Payload>

Provides information on the content being installed.

relocate: Vec<BundleRef>

scripts: Scripts

Scripts to run before and after install.

strict_identifiers: Vec<BundleRef>

update_bundle: Vec<BundleRef>

upgrade_bundle: Vec<BundleRef>

Implementations

impl PackageInfo

pub fn from_reader(reader: impl Read) -> PkgResult<Self>

Parse Distribution XML from a reader.

pub fn from_xml(s: &str) -> PkgResult<Self>

Parse Distribution XML from a string.

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 Default for PackageInfo

fn default() -> Self

Returns the “default value” for a type.

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 PartialEq for PackageInfo

fn eq(&self, other: &PackageInfo) -> 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 PackageInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PackageInfo

impl StructuralPartialEq for PackageInfo