Struct SourceInfo

pub struct SourceInfo {
    pub base: PackageBase,
    pub packages: Vec<Package>,
}

The representation of SRCINFO data.

Provides access to a PackageBase which tracks all data in a pkgbase section and a list of Package instances that provide the accumulated data of all pkgname sections.

This is the entry point for parsing SRCINFO files. Once created, Self::packages_for_architecture can be used to create usable MergedPackages.

Fields

base: PackageBase

packages: Vec<Package>

Implementations

impl SourceInfo

pub fn from_file(path: &Path) -> Result<SourceInfoResult, Error>

Reads the file at the specified path and converts it into a SourceInfo struct.

Errors

Returns an Error if the file cannot be read or parsed. Returns an error array with potentially un/-recoverable errors, this needs to be explicitly handled by the user.

pub fn from_string(content: &str) -> Result<SourceInfoResult, Error>

Parses a SRCINFO file’s content into a SourceInfo struct.

Error

This function returns two types of errors.

1. An Error is returned if the input is, for example, invalid UTF-8 or if the input SRCINFO file couldn’t be parsed due to invalid syntax.
2. If the parsing was successful, a SourceInfoResult is returned, which wraps a possibly invalid SourceInfo and possible SourceInfoErrors. SourceInfoErrors contains all errors and lint/deprecation warnings that’re encountered while interpreting the SRCINFO file.

use alpm_srcinfo::SourceInfo;
use alpm_types::{Architecture, Name, PackageRelation};

let source_info_data = r#"
pkgbase = example
    pkgver = 1.0.0
    epoch = 1
    pkgrel = 1
    pkgdesc = A project that does something
    url = https://example.org/
    arch = x86_64
    depends = glibc
    optdepends = python: for special-python-script.py
    makedepends = cmake
    checkdepends = extra-test-tool

pkgname = example
    depends = glibc
    depends = gcc-libs
"#;

// Parse the file. This might already error if the file cannot be parsed on a low level.
let source_info_result = SourceInfo::from_string(source_info_data)?;
// Make sure there're no other unrecoverable errors.
let source_info = source_info_result.source_info()?;

pub fn from_raw( content: SourceInfoContent, ) -> (SourceInfo, Vec<SourceInfoError>)

Reads raw SourceInfoContent from a first parsing step and converts it into a SourceInfo.

Instead of a Result this function returns a tuple of SourceInfo and a vector of SourceInfoErrors. The caller is expected to handle the vector of SourceInfoErrors, which may only consist of linting errors that can be ignored.

pub fn packages_for_architecture( &self, architecture: Architecture, ) -> MergedPackagesIterator<'_>

Get an iterator over all packages

use alpm_srcinfo::{MergedPackage, SourceInfo};
use alpm_types::{Architecture, Name, PackageRelation};

let source_info_data = r#"
pkgbase = example
    pkgver = 1.0.0
    epoch = 1
    pkgrel = 1
    arch = x86_64

pkgname = example
    pkgdesc = Example split package

pkgname = example_other
    pkgdesc = The other example split package
"#;
// Parse the file. This might already error if the file cannot be parsed on a low level.
let result = SourceInfo::from_string(source_info_data)?;
// Make sure there're aren't unrecoverable logic errors, such as missing values.
let source_info = result.source_info()?;

/// Get all merged package representations for the x86_64 architecture.
let mut packages = source_info.packages_for_architecture(Architecture::X86_64);

let example = packages.next().unwrap();
assert_eq!(
    example.description,
    Some("Example split package".to_string())
);

let example_other = packages.next().unwrap();
assert_eq!(
    example_other.description,
    Some("The other example split package".to_string())
);

Trait Implementations

impl Clone for SourceInfo

fn clone(&self) -> SourceInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceInfo

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

Formats the value using the given formatter.