pub enum RepoDescSchema {
V1(SchemaVersion),
V2(SchemaVersion),
}Expand description
An enum describing all valid alpm-repo-desc schemas.
Each variant corresponds to a specific revision of the specification.
Variants§
V1(SchemaVersion)
Schema for the alpm-repo-descv1 file format.
V2(SchemaVersion)
Schema for the alpm-repo-descv2 file format.
Trait Implementations§
Source§impl AsRef<SchemaVersion> for RepoDescSchema
impl AsRef<SchemaVersion> for RepoDescSchema
Source§fn as_ref(&self) -> &SchemaVersion
fn as_ref(&self) -> &SchemaVersion
Returns a reference to the targeted SchemaVersion.
Source§impl Clone for RepoDescSchema
impl Clone for RepoDescSchema
Source§impl Debug for RepoDescSchema
impl Debug for RepoDescSchema
Source§impl Default for RepoDescSchema
impl Default for RepoDescSchema
Source§fn default() -> Self
fn default() -> Self
Returns the default schema variant (RepoDescSchema::V2).
Source§impl Display for RepoDescSchema
impl Display for RepoDescSchema
impl Eq for RepoDescSchema
Source§impl FileFormatSchema for RepoDescSchema
impl FileFormatSchema for RepoDescSchema
Source§fn derive_from_file(file: impl AsRef<Path>) -> Result<Self, Error>where
Self: Sized,
fn derive_from_file(file: impl AsRef<Path>) -> Result<Self, Error>where
Self: Sized,
Derives a RepoDescSchema from an alpm-repo-desc file on disk.
Opens the file and defers to RepoDescSchema::derive_from_reader.
§Errors
Returns an error if:
- the file cannot be opened for reading,
- or deriving a
RepoDescSchemafrom its contents fails.
Source§fn derive_from_reader(reader: impl Read) -> Result<Self, Error>where
Self: Sized,
fn derive_from_reader(reader: impl Read) -> Result<Self, Error>where
Self: Sized,
Derives a RepoDescSchema from alpm-repo-desc data in a reader.
Reads the reader to a string and defers to RepoDescSchema::derive_from_str.
§Errors
Returns an error if:
- reading from
readerfails, - or deriving a
RepoDescSchemafrom its contents fails.
Source§fn derive_from_str(s: &str) -> Result<RepoDescSchema, Error>
fn derive_from_str(s: &str) -> Result<RepoDescSchema, Error>
Derives a RepoDescSchema from a string slice containing alpm-repo-desc data.
The parser uses a simple heuristic:
- v1 →
%MD5SUM%section present - v2 → no
%MD5SUM%section present
This approach avoids relying on explicit version metadata, as the package repository desc format itself is not self-describing.
§Examples
use alpm_common::FileFormatSchema;
use alpm_repo_db::desc::RepoDescSchema;
use alpm_types::{SchemaVersion, semver_version::Version};
let v1_data = r#"%FILENAME%
example-meta-1.0.0-1-any.pkg.tar.zst
%NAME%
example-meta
%BASE%
example-meta
%VERSION%
1.0.0-1
%DESC%
An example meta package
%CSIZE%
4634
%ISIZE%
0
%MD5SUM%
d3b07384d113edec49eaa6238ad5ff00
%SHA256SUM%
b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
%PGPSIG%
iHUEABYKAB0WIQRizHP4hOUpV7L92IObeih9mi7GCAUCaBZuVAAKCRCbeih9mi7GCIlMAP9ws/jU4f580ZRQlTQKvUiLbAZOdcB7mQQj83hD1Nc/GwD/WIHhO1/OQkpMERejUrLo3AgVmY3b4/uGhx9XufWEbgE=
%URL%
https://example.org/
%LICENSE%
GPL-3.0-or-later
%ARCH%
any
%BUILDDATE%
1729181726
%PACKAGER%
Foobar McFooface <foobar@mcfooface.org>
"#;
assert_eq!(
RepoDescSchema::V1(SchemaVersion::new(Version::new(1, 0, 0))),
RepoDescSchema::derive_from_str(v1_data)?
);
let v2_data = r#"%FILENAME%
example-meta-1.0.0-1-any.pkg.tar.zst
%NAME%
example-meta
%BASE%
example-meta
%VERSION%
1.0.0-1
%DESC%
An example meta package
%CSIZE%
4634
%ISIZE%
0
%SHA256SUM%
b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
%URL%
https://example.org/
%LICENSE%
GPL-3.0-or-later
%ARCH%
any
%BUILDDATE%
1729181726
%PACKAGER%
Foobar McFooface <foobar@mcfooface.org>
"#;
assert_eq!(
RepoDescSchema::V2(SchemaVersion::new(Version::new(2, 0, 0))),
RepoDescSchema::derive_from_str(v2_data)?
);§Errors
Returns an error only if internal conversion or string handling fails.
Source§impl FromStr for RepoDescSchema
impl FromStr for RepoDescSchema
Source§fn from_str(s: &str) -> Result<RepoDescSchema, Self::Err>
fn from_str(s: &str) -> Result<RepoDescSchema, Self::Err>
Parses a RepoDescSchema from a version string.
§Errors
Returns an error if:
- the input string is not a valid version,
- or the version does not correspond to a known schema variant.
Source§impl MetadataFile<RepoDescSchema> for RepoDescFile
impl MetadataFile<RepoDescSchema> for RepoDescFile
Source§fn from_file_with_schema(
file: impl AsRef<Path>,
schema: Option<RepoDescSchema>,
) -> Result<Self, Error>
fn from_file_with_schema( file: impl AsRef<Path>, schema: Option<RepoDescSchema>, ) -> Result<Self, Error>
Creates a RepoDescFile from a file on disk, optionally validated using a
RepoDescSchema.
Opens the file and defers to RepoDescFile::from_reader_with_schema.
§Examples
use std::{fs::File, io::Write};
use alpm_common::{FileFormatSchema, MetadataFile};
use alpm_repo_db::desc::{RepoDescFile, RepoDescSchema};
use alpm_types::{SchemaVersion, semver_version::Version};
// Prepare a file with package repository desc data (v1)
let (file, desc_data) = {
let desc_data = r#"%FILENAME%
example-meta-1.0.0-1-any.pkg.tar.zst
%NAME%
example-meta
%BASE%
example-meta
%VERSION%
1.0.0-1
%DESC%
An example meta package
%CSIZE%
4634
%ISIZE%
0
%MD5SUM%
d3b07384d113edec49eaa6238ad5ff00
%SHA256SUM%
b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
%PGPSIG%
iHUEABYKAB0WIQRizHP4hOUpV7L92IObeih9mi7GCAUCaBZuVAAKCRCbeih9mi7GCIlMAP9ws/jU4f580ZRQlTQKvUiLbAZOdcB7mQQj83hD1Nc/GwD/WIHhO1/OQkpMERejUrLo3AgVmY3b4/uGhx9XufWEbgE=
%URL%
https://example.org/
%LICENSE%
GPL-3.0-or-later
%ARCH%
any
%BUILDDATE%
1729181726
%PACKAGER%
Foobar McFooface <foobar@mcfooface.org>
"#;
let file = tempfile::NamedTempFile::new()?;
let mut output = File::create(&file)?;
write!(output, "{}", desc_data)?;
(file, desc_data)
};
let repo_desc = RepoDescFile::from_file_with_schema(
file.path(),
Some(RepoDescSchema::V1(SchemaVersion::new(Version::new(
1, 0, 0,
)))),
)?;
assert_eq!(repo_desc.to_string(), desc_data);§Errors
Returns an error if:
- the file cannot be opened for reading,
- the contents cannot be parsed into any known
RepoDescFilevariant, - or the provided
RepoDescSchemadoes not match the contents of the file.
Source§fn from_reader_with_schema(
reader: impl Read,
schema: Option<RepoDescSchema>,
) -> Result<Self, Error>
fn from_reader_with_schema( reader: impl Read, schema: Option<RepoDescSchema>, ) -> Result<Self, Error>
Creates a RepoDescFile from any readable stream, optionally validated using a
RepoDescSchema.
Reads the reader to a string buffer and defers to RepoDescFile::from_str_with_schema.
§Examples
use std::{fs::File, io::Write};
use alpm_common::MetadataFile;
use alpm_repo_db::desc::{RepoDescFile, RepoDescSchema};
use alpm_types::{SchemaVersion, semver_version::Version};
// Prepare a reader with package repository desc data (v2)
let (reader, desc_data) = {
let desc_data = r#"%FILENAME%
example-meta-1.0.0-1-any.pkg.tar.zst
%NAME%
example-meta
%BASE%
example-meta
%VERSION%
1.0.0-1
%DESC%
An example meta package
%CSIZE%
4634
%ISIZE%
0
%SHA256SUM%
b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
%URL%
https://example.org/
%LICENSE%
GPL-3.0-or-later
%ARCH%
any
%BUILDDATE%
1729181726
%PACKAGER%
Foobar McFooface <foobar@mcfooface.org>
"#;
let file = tempfile::NamedTempFile::new()?;
let mut output = File::create(&file)?;
write!(output, "{}", desc_data)?;
(File::open(&file.path())?, desc_data)
};
let repo_desc = RepoDescFile::from_reader_with_schema(
reader,
Some(RepoDescSchema::V2(SchemaVersion::new(Version::new(
2, 0, 0,
)))),
)?;
assert_eq!(repo_desc.to_string(), desc_data);§Errors
Returns an error if:
- the
readercannot be read to string, - the data cannot be parsed into a known
RepoDescFilevariant, - or the provided
RepoDescSchemadoes not match the parsed content.
Source§fn from_str_with_schema(
s: &str,
schema: Option<RepoDescSchema>,
) -> Result<Self, Error>
fn from_str_with_schema( s: &str, schema: Option<RepoDescSchema>, ) -> Result<Self, Error>
Creates a RepoDescFile from a string slice, optionally validated using a
RepoDescSchema.
If schema is None, automatically infers the schema version by inspecting the input
(v1 if %MD5SUM% is present, v2 otherwise).
§Examples
use alpm_common::MetadataFile;
use alpm_repo_db::desc::{RepoDescFile, RepoDescSchema};
use alpm_types::{SchemaVersion, semver_version::Version};
let v1_data = r#"%FILENAME%
example-meta-1.0.0-1-any.pkg.tar.zst
%NAME%
example-meta
%BASE%
example-meta
%VERSION%
1.0.0-1
%DESC%
An example meta package
%CSIZE%
4634
%ISIZE%
0
%MD5SUM%
d3b07384d113edec49eaa6238ad5ff00
%SHA256SUM%
b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
%PGPSIG%
iHUEABYKAB0WIQRizHP4hOUpV7L92IObeih9mi7GCAUCaBZuVAAKCRCbeih9mi7GCIlMAP9ws/jU4f580ZRQlTQKvUiLbAZOdcB7mQQj83hD1Nc/GwD/WIHhO1/OQkpMERejUrLo3AgVmY3b4/uGhx9XufWEbgE=
%URL%
https://example.org/
%LICENSE%
GPL-3.0-or-later
%ARCH%
any
%BUILDDATE%
1729181726
%PACKAGER%
Foobar McFooface <foobar@mcfooface.org>
"#;
let repo_desc_v1 = RepoDescFile::from_str_with_schema(
v1_data,
Some(RepoDescSchema::V1(SchemaVersion::new(Version::new(
1, 0, 0,
)))),
)?;
assert_eq!(repo_desc_v1.to_string(), v1_data);
let v2_data = r#"%FILENAME%
example-meta-1.0.0-1-any.pkg.tar.zst
%NAME%
example-meta
%BASE%
example-meta
%VERSION%
1.0.0-1
%DESC%
An example meta package
%CSIZE%
4634
%ISIZE%
0
%SHA256SUM%
b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
%URL%
https://example.org/
%LICENSE%
GPL-3.0-or-later
%ARCH%
any
%BUILDDATE%
1729181726
%PACKAGER%
Foobar McFooface <foobar@mcfooface.org>
"#;
let repo_desc_v2 = RepoDescFile::from_str_with_schema(
v2_data,
Some(RepoDescSchema::V2(SchemaVersion::new(Version::new(
2, 0, 0,
)))),
)?;
assert_eq!(repo_desc_v2.to_string(), v2_data);§Errors
Returns an error if:
- the input cannot be parsed into a valid
RepoDescFile, - or the derived or provided schema does not match the detected format.
Source§impl PartialEq for RepoDescSchema
impl PartialEq for RepoDescSchema
impl StructuralPartialEq for RepoDescSchema
Source§impl TryFrom<SchemaVersion> for RepoDescSchema
impl TryFrom<SchemaVersion> for RepoDescSchema
Source§fn try_from(value: SchemaVersion) -> Result<Self, Self::Error>
fn try_from(value: SchemaVersion) -> Result<Self, Self::Error>
Converts a SchemaVersion into a corresponding RepoDescSchema.
§Errors
Returns an error if the major version of SchemaVersion does not
correspond to a known RepoDescSchema variant.