Struct Package

pub struct Package {
    file_name: PackageFileName,
    parent_dir: ExistingAbsoluteDir,
}

An alpm-package file.

Tracks the PackageFileName of the alpm-package as well as its absolute parent_dir.

Fields

file_name: PackageFileName

parent_dir: ExistingAbsoluteDir

Implementations

impl Package

pub fn new( file_name: PackageFileName, parent_dir: ExistingAbsoluteDir, ) -> Result<Self, Error>

Creates a new Package.

Errors

Returns an error if no file exists at the path defined by parent_dir and filename.

pub fn to_path_buf(&self) -> PathBuf

Returns the absolute path of the Package.

pub fn read_pkginfo(&self) -> Result<PackageInfo, Error>

Returns the PackageInfo of the package.

This is a convenience wrapper around PackageReader::read_metadata_file.

Errors

Returns an error if

• a PackageReader cannot be created for the package,
• the package does not contain a PKGINFO file,
• or the PKGINFO file in the package is not valid.

pub fn read_buildinfo(&self) -> Result<BuildInfo, Error>

Returns the BuildInfo of the package.

This is a convenience wrapper around PackageReader::read_metadata_file.

Errors

Returns an error if

• a PackageReader cannot be created for the package,
• the package does not contain a BUILDINFO file,
• or the BUILDINFO file in the package is not valid.

pub fn read_mtree(&self) -> Result<Mtree, Error>

Returns the Mtree of the package.

This is a convenience wrapper around PackageReader::read_metadata_file.

Errors

Returns an error if

• a PackageReader cannot be created for the package,
• the package does not contain a ALPM-MTREE file,
• or the ALPM-MTREE file in the package is not valid.

pub fn read_install_scriptlet(&self) -> Result<Option<String>, Error>

Returns the contents of the optional alpm-install-scriptlet of the package.

Returns None if the package does not contain an alpm-install-scriptlet file.

Errors

Returns an error if

• a PackageReader cannot be created for the package,
• or reading the entries using PackageReader::metadata_entries.

pub fn into_reader<'c>(self) -> Result<PackageReader<'c>, Error>

Creates a PackageReader for the package.

Convenience wrapper for PackageReader::try_from.

Errors

Returns an error if self cannot be converted into a PackageReader.

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a duplicate 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 TryFrom<&PackageCreationConfig> for Package

fn try_from(value: &PackageCreationConfig) -> Result<Self, Self::Error>

Creates a new Package from a PackageCreationConfig.

Before creating a Package, guarantees the on-disk file consistency with the help of available Mtree data.

Errors

Returns an error if

• creating a PackageFileName from value fails,
• creating a CompressionEncoder fails,
• creating a compressed or uncompressed package file fails,
• validating any of the paths using ALPM-MTREE data (available through value) fails,
• appending files to a compressed or uncompressed package file fails,
• finishing a compressed or uncompressed package file fails,
• or creating a Package fails.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<&Path> for Package

fn try_from(value: &Path) -> Result<Self, Self::Error>

Creates a Package from a Path reference.

Errors

Returns an error if

• no file name can be retrieved from path,
• value has no parent directory,
• or Package::new fails.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<Package> for PackageReader<'_>

fn try_from(package: Package) -> Result<Self, Self::Error>

Creates a PackageReader from a Package.

Errors

Returns an error if:

• the package file cannot be opened,
• the package file extension cannot be determined,
• or the compression decoder cannot be created from the file and its extension.

type Error = Error

The type returned in the event of a conversion error.