Struct BinaryPackage 

pub struct BinaryPackage { /* private fields */ }

A pkgsrc binary package with cached metadata.

This provides fast access to package metadata without re-reading the archive. The metadata is read once during BinaryPackage::open, and subsequent operations like BinaryPackage::archive or BinaryPackage::extract_to re-open the archive as needed.

Example

use pkgsrc::archive::BinaryPackage;

// Fast metadata access
let pkg = BinaryPackage::open("package-1.0.tgz").unwrap();
println!("Name: {}", pkg.pkgname().unwrap_or("unknown"));
println!("Comment: {}", pkg.metadata().comment());

// Generate summary for repository
let summary = pkg.to_summary().unwrap();

// Extract files (re-reads archive)
pkg.extract_to("/usr/pkg").unwrap();

Implementations

impl BinaryPackage

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Open a package from a file path.

This reads only the metadata entries at the start of the archive, providing fast access to package information without decompressing the entire file.

pub fn path(&self) -> &Path

Return the path to the package file.

pub fn compression(&self) -> Compression

Return the compression format.

pub fn archive_type(&self) -> ArchiveType

Return the archive type (signed or unsigned).

pub fn is_signed(&self) -> bool

Return whether this package is signed.

pub fn metadata(&self) -> &Metadata

Return the package metadata.

pub fn plist(&self) -> &Plist

Return the packing list.

pub fn pkgname(&self) -> Option<&str>

Return the package name from the plist.

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

Return the build info key-value pairs.

pub fn build_info_value(&self, key: &str) -> Option<&str>

Get a specific build info value (first value if multiple exist).

pub fn build_info_values(&self, key: &str) -> Option<&[String]>

Get all values for a build info key.

pub fn pkg_hash(&self) -> Option<&PkgHash>

Return the package hash (for signed packages).

pub fn gpg_signature(&self) -> Option<&[u8]>

Return the GPG signature (for signed packages).

pub fn file_size(&self) -> u64

Return the file size of the package.

pub fn archive(&self) -> Result<Archive<BufReader<File>>>

Open the archive for iteration (re-reads the file).

pub fn extract_to(&self, dest: impl AsRef<Path>) -> Result<()>

Extract all files to a destination directory.

This re-reads the archive and extracts all entries.

pub fn extract_with_plist( &self, dest: impl AsRef<Path>, options: ExtractOptions, ) -> Result<Vec<ExtractedFile>>

Extract files to a destination directory with plist-based permissions.

This method extracts files and applies permissions specified in the packing list (@mode, @owner, @group directives).

Arguments

• dest - Destination directory for extraction
• options - Extraction options controlling mode/ownership application

Returns

A vector of ExtractedFile describing each extracted file.

Example

use pkgsrc::archive::{BinaryPackage, ExtractOptions};

let pkg = BinaryPackage::open("package-1.0.tgz").unwrap();
let options = ExtractOptions::new().with_mode();
let extracted = pkg.extract_with_plist("/usr/pkg", options).unwrap();
for file in &extracted {
    println!("Extracted: {}", file.path.display());
}

pub fn verify_checksums( &self, dest: impl AsRef<Path>, ) -> Result<Vec<(PathBuf, String, String)>>

Verify checksums of extracted files against plist MD5 values.

This method checks that files in the destination directory match the MD5 checksums recorded in the packing list.

Arguments

• dest - Directory where files were extracted

Returns

A vector of tuples containing (file_path, expected_hash, actual_hash) for files that failed verification. Empty vector means all passed.

pub fn sign(&self, signature: &[u8]) -> Result<SignedArchive>

Sign this package.

Re-reads the package file to compute hashes and create a signed archive.

pub fn to_summary(&self) -> Result<Summary>

Convert this package to a Summary entry.

This uses default options (no file checksum computation). Use to_summary_with_opts for more control.

pub fn to_summary_with_opts(&self, opts: &SummaryOptions) -> Result<Summary>

Convert this package to a Summary entry with options.

Example

use pkgsrc::archive::{BinaryPackage, SummaryOptions};

let pkg = BinaryPackage::open("package-1.0.tgz").unwrap();
let opts = SummaryOptions { compute_file_cksum: true };
let summary = pkg.to_summary_with_opts(&opts).unwrap();

Trait Implementations

impl Debug for BinaryPackage

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

Formats the value using the given formatter.

impl FileRead for BinaryPackage

fn pkgname(&self) -> &str

Package name including version (e.g., “foo-1.0”).

fn comment(&self) -> Result<String>

Package comment (+COMMENT). Single line description.

fn contents(&self) -> Result<String>

Package contents (+CONTENTS). The packing list.

fn desc(&self) -> Result<String>

Package description (+DESC). Multi-line description.

fn build_info(&self) -> Result<Option<String>>

Build information (+BUILD_INFO).

fn build_version(&self) -> Result<Option<String>>

Build version (+BUILD_VERSION).

fn deinstall(&self) -> Result<Option<String>>

Deinstall script (+DEINSTALL).

fn display(&self) -> Result<Option<String>>

Display file (+DISPLAY).

fn install(&self) -> Result<Option<String>>

Install script (+INSTALL).

fn installed_info(&self) -> Result<Option<String>>

Installed info (+INSTALLED_INFO).

fn mtree_dirs(&self) -> Result<Option<String>>

Mtree dirs (+MTREE_DIRS).

fn preserve(&self) -> Result<Option<String>>

Preserve file (+PRESERVE).

fn required_by(&self) -> Result<Option<String>>

Required by (+REQUIRED_BY).

fn size_all(&self) -> Result<Option<String>>

Total size including dependencies (+SIZE_ALL).

fn size_pkg(&self) -> Result<Option<String>>

Package size (+SIZE_PKG).

impl TryFrom<&BinaryPackage> for Summary

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pkg: &BinaryPackage) -> Result<Self>

Performs the conversion.