pub enum PackageInfo {
V1(PackageInfoV1),
V2(PackageInfoV2),
}Expand description
A representation of the PKGINFO file format.
Tracks all available versions of the file format.
Variants§
Trait Implementations§
Source§impl Clone for PackageInfo
impl Clone for PackageInfo
Source§impl Debug for PackageInfo
impl Debug for PackageInfo
Source§impl Display for PackageInfo
impl Display for PackageInfo
Source§impl FromStr for PackageInfo
impl FromStr for PackageInfo
Source§fn from_str(s: &str) -> Result<Self, Self::Err>
fn from_str(s: &str) -> Result<Self, Self::Err>
Creates a PackageInfo from string slice s.
Calls PackageInfo::from_str_with_schema with schema set to None.
§Errors
Returns an error if
- a
PackageInfoSchemacannot be derived froms, - or the detected variant of
PackageInfocannot be constructed froms.
Source§impl MetadataFile<PackageInfoSchema> for PackageInfo
impl MetadataFile<PackageInfoSchema> for PackageInfo
Source§fn from_file_with_schema(
file: impl AsRef<Path>,
schema: Option<PackageInfoSchema>,
) -> Result<Self, Error>
fn from_file_with_schema( file: impl AsRef<Path>, schema: Option<PackageInfoSchema>, ) -> Result<Self, Error>
Creates a PackageInfo from file, optionally validated using a PackageInfoSchema.
Opens the file and defers to PackageInfo::from_reader_with_schema.
§Note
To automatically derive the PackageInfoSchema, use PackageInfo::from_file.
§Examples
use std::{fs::File, io::Write};
use alpm_common::{FileFormatSchema, MetadataFile};
use alpm_pkginfo::{PackageInfo, PackageInfoSchema};
use alpm_types::{SchemaVersion, semver_version::Version};
// Prepare a file with PKGINFO data
let (file, pkginfo_data) = {
let pkginfo_data = r#"pkgname = example
pkgbase = example
xdata = pkgtype=pkg
pkgver = 1:1.0.0-1
pkgdesc = A project that does something
url = https://example.org/
builddate = 1729181726
packager = John Doe <john@example.org>
size = 181849963
arch = any
"#;
let pkginfo_file = tempfile::NamedTempFile::new()?;
let mut output = File::create(&pkginfo_file)?;
write!(output, "{}", pkginfo_data)?;
(pkginfo_file, pkginfo_data)
};
let pkginfo = PackageInfo::from_file_with_schema(
file.path().to_path_buf(),
Some(PackageInfoSchema::V2(SchemaVersion::new(Version::new(
2, 0, 0,
)))),
)?;
assert_eq!(pkginfo.to_string(), pkginfo_data);§Errors
Returns an error if
- the
filecannot be opened for reading, - no variant of
PackageInfocan be constructed from the contents offile, - or
schemaisSomeand thePackageInfoSchemadoes not match the contents offile.
Source§fn from_reader_with_schema(
reader: impl Read,
schema: Option<PackageInfoSchema>,
) -> Result<Self, Error>
fn from_reader_with_schema( reader: impl Read, schema: Option<PackageInfoSchema>, ) -> Result<Self, Error>
Creates a PackageInfo from a reader, optionally validated using a
PackageInfoSchema.
Reads the reader to string and defers to PackageInfo::from_str_with_schema.
§Note
To automatically derive the PackageInfoSchema, use PackageInfo::from_reader.
§Examples
use std::{fs::File, io::Write};
use alpm_common::MetadataFile;
use alpm_pkginfo::{PackageInfo, PackageInfoSchema};
use alpm_types::{SchemaVersion, semver_version::Version};
// Prepare a reader with PKGINFO data
let (reader, pkginfo_data) = {
let pkginfo_data = r#"pkgname = example
pkgbase = example
xdata = pkgtype=pkg
pkgver = 1:1.0.0-1
pkgdesc = A project that does something
url = https://example.org/
builddate = 1729181726
packager = John Doe <john@example.org>
size = 181849963
arch = any
"#;
let pkginfo_file = tempfile::NamedTempFile::new()?;
let mut output = File::create(&pkginfo_file)?;
write!(output, "{}", pkginfo_data)?;
(File::open(&pkginfo_file.path())?, pkginfo_data)
};
let pkginfo = PackageInfo::from_reader_with_schema(
reader,
Some(PackageInfoSchema::V2(SchemaVersion::new(Version::new(
2, 0, 0,
)))),
)?;
assert_eq!(pkginfo.to_string(), pkginfo_data);§Errors
Returns an error if
- the
readercannot be read to string, - no variant of
PackageInfocan be constructed from the contents of thereader, - or
schemaisSomeand thePackageInfoSchemadoes not match the contents of thereader.
Source§fn from_str_with_schema(
s: &str,
schema: Option<PackageInfoSchema>,
) -> Result<Self, Error>
fn from_str_with_schema( s: &str, schema: Option<PackageInfoSchema>, ) -> Result<Self, Error>
Creates a PackageInfo from string slice, optionally validated using a
PackageInfoSchema.
If schema is None attempts to detect the PackageInfoSchema from s.
Attempts to create a PackageInfo variant that corresponds to the PackageInfoSchema.
§Note
To automatically derive the PackageInfoSchema, use PackageInfo::from_str.
§Examples
use std::{fs::File, io::Write};
use alpm_common::MetadataFile;
use alpm_pkginfo::{PackageInfo, PackageInfoSchema};
use alpm_types::{SchemaVersion, semver_version::Version};
let pkginfo_v2_data = r#"pkgname = example
pkgbase = example
xdata = pkgtype=pkg
pkgver = 1:1.0.0-1
pkgdesc = A project that does something
url = https://example.org/
builddate = 1729181726
packager = John Doe <john@example.org>
size = 181849963
arch = any
"#;
let pkginfo_v2 = PackageInfo::from_str_with_schema(
pkginfo_v2_data,
Some(PackageInfoSchema::V2(SchemaVersion::new(Version::new(
2, 0, 0,
)))),
)?;
assert_eq!(pkginfo_v2.to_string(), pkginfo_v2_data);
let pkginfo_v1_data = r#"pkgname = example
pkgbase = example
pkgver = 1:1.0.0-1
pkgdesc = A project that does something
url = https://example.org/
builddate = 1729181726
packager = John Doe <john@example.org>
size = 181849963
arch = any
"#;
let pkginfo_v1 = PackageInfo::from_str_with_schema(
pkginfo_v1_data,
Some(PackageInfoSchema::V1(SchemaVersion::new(Version::new(
1, 0, 0,
)))),
)?;
assert_eq!(pkginfo_v1.to_string(), pkginfo_v1_data);§Errors
Returns an error if
schemaisSomeand the specified variant ofPackageInfocannot be constructed froms,schemaisNoneand- a
PackageInfoSchemacannot be derived froms, - or the detected variant of
PackageInfocannot be constructed froms.
- a