Enum SourceInfoSchema

pub enum SourceInfoSchema {
    V1(SchemaVersion),
}

An enum tracking all available SRCINFO schemas.

The schema of a SRCINFO refers to the minimum required sections and keywords, as well as the complete set of available keywords in a specific version.

Variants

V1(SchemaVersion)

Trait Implementations

impl Clone for SourceInfoSchema

fn clone(&self) -> SourceInfoSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceInfoSchema

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

Formats the value using the given formatter.

impl Default for SourceInfoSchema

fn default() -> Self

Returns the default SourceInfoSchema variant (SourceInfoSchema::V1).

impl Display for SourceInfoSchema

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

Formats the value using the given formatter.

impl FileFormatSchema for SourceInfoSchema

fn inner(&self) -> &SchemaVersion

Returns a reference to the inner SchemaVersion.

fn derive_from_file(file: impl AsRef<Path>) -> Result<Self, Error>

where Self: Sized,

Derives a SourceInfoSchema from a SRCINFO file.

Opens the file and defers to SourceInfoSchema::derive_from_reader.

Errors

Returns an error if

• opening file for reading fails
• or deriving a SourceInfoSchema from the contents of file fails.

fn derive_from_reader(reader: impl Read) -> Result<Self, Error>

where Self: Sized,

Derives a SourceInfoSchema from SRCINFO data in a reader.

Reads the reader to string and defers to SourceInfoSchema::derive_from_str.

Errors

Returns an error if

• reading a String from reader fails
• or deriving a SourceInfoSchema from the contents of reader fails.

fn derive_from_str(s: &str) -> Result<SourceInfoSchema, Error>

Derives a SourceInfoSchema from a string slice containing SRCINFO data.

Since the SRCINFO format is only covered by a single version and it not carrying any version information, this function checks whether s contains at least the sections pkgbase and pkgname and the keywords pkgver and pkgrel.

Examples

use alpm_common::FileFormatSchema;
use alpm_srcinfo::SourceInfoSchema;
use alpm_types::{SchemaVersion, semver_version::Version};

let srcinfo_data = r#"
pkgbase = example
    pkgdesc = An example
    pkgver = 0.1.0
    pkgrel = 1

pkgname = example
"#;

Errors

Returns an error if s cannot be parsed.

type Err = Error

The Error type to use.

impl FromStr for SourceInfoSchema

fn from_str(s: &str) -> Result<SourceInfoSchema, Self::Err>

Creates a SourceInfoSchema from string slice s.

Relies on SchemaVersion::from_str to create a corresponding SourceInfoSchema from s.

Errors

Returns an error if

• no SchemaVersion can be created from s,
• or the conversion from SchemaVersion to SourceInfoSchema fails.

type Err = Error

The associated error which can be returned from parsing.

impl MetadataFile<SourceInfoSchema> for SourceInfo

fn from_file_with_schema( file: impl AsRef<Path>, schema: Option<SourceInfoSchema>, ) -> Result<Self, Error>

Creates a SourceInfo from file, optionally validated using a SourceInfoSchema.

Opens the file and defers to SourceInfo::from_reader_with_schema.

Note

To automatically derive the SourceInfoSchema, use SourceInfo::from_file.

Examples

use std::{fs::File, io::Write};

use alpm_common::{FileFormatSchema, MetadataFile};
use alpm_srcinfo::{SourceInfo, SourceInfoSchema};
use alpm_types::{SchemaVersion, semver_version::Version};

// Prepare a file with SRCINFO data
let srcinfo_file = tempfile::NamedTempFile::new()?;
let (file, srcinfo_data) = {
    let srcinfo_data = r#"
pkgbase = example
    pkgdesc = An example
    pkgver = 0.1.0
    pkgrel = 1

pkgname = example
"#;
    let mut output = File::create(&srcinfo_file)?;
    write!(output, "{}", srcinfo_data)?;
    (srcinfo_file, srcinfo_data)
};

let srcinfo = SourceInfo::from_file_with_schema(
    file.path().to_path_buf(),
    Some(SourceInfoSchema::V1(SchemaVersion::new(Version::new(
        1, 0, 0,
    )))),
)?;

Errors

Returns an error if

• the file cannot be opened for reading,
• no variant of SourceInfo can be constructed from the contents of file,
• or schema is Some and the SourceInfoSchema does not match the contents of file.

fn from_reader_with_schema( reader: impl Read, schema: Option<SourceInfoSchema>, ) -> Result<Self, Error>

Creates a SourceInfo from a reader, optionally validated using a SourceInfoSchema.

Reads the reader to string and defers to SourceInfo::from_str_with_schema.

Note

To automatically derive the SourceInfoSchema, use SourceInfo::from_reader.

Examples

use std::{fs::File, io::Write};

use alpm_common::MetadataFile;
use alpm_srcinfo::{SourceInfo, SourceInfoSchema};
use alpm_types::{SchemaVersion, semver_version::Version};

let srcinfo_file = tempfile::NamedTempFile::new()?;
// Prepare a reader with SRCINFO data
let (reader, srcinfo_data) = {
    let srcinfo_data = r#"
pkgbase = example
    pkgdesc = An example
    pkgver = 0.1.0
    pkgrel = 1

pkgname = example
"#;
    let mut output = File::create(&srcinfo_file)?;
    write!(output, "{}", srcinfo_data)?;
    (File::open(&srcinfo_file.path())?, srcinfo_data)
};

let srcinfo = SourceInfo::from_reader_with_schema(
    reader,
    Some(SourceInfoSchema::V1(SchemaVersion::new(Version::new(
        1, 0, 0,
    )))),
)?;

Errors

Returns an error if

• the reader cannot be read to string,
• no variant of SourceInfo can be constructed from the contents of the reader,
• or schema is Some and the SourceInfoSchema does not match the contents of the reader.

fn from_str_with_schema( s: &str, schema: Option<SourceInfoSchema>, ) -> Result<Self, Error>

Creates a SourceInfo from string slice, optionally validated using a SourceInfoSchema.

If schema is None attempts to detect the SourceInfoSchema from s. Attempts to create a SourceInfo variant that corresponds to the SourceInfoSchema.

Note

To automatically derive the SourceInfoSchema, use SourceInfo::from_str.

Examples

use std::{fs::File, io::Write};

use alpm_common::MetadataFile;
use alpm_srcinfo::{SourceInfo, SourceInfoSchema};
use alpm_types::{SchemaVersion, semver_version::Version};

let srcinfo_data = r#"
pkgbase = example
    pkgdesc = An example
    pkgver = 0.1.0
    pkgrel = 1

pkgname = example
"#;

let srcinfo = SourceInfo::from_str_with_schema(
    srcinfo_data,
    Some(SourceInfoSchema::V1(SchemaVersion::new(Version::new(
        1, 0, 0,
    )))),
)?;

Errors

Returns an error if

• schema is Some and the specified variant of SourceInfo cannot be constructed from s,
• schema is None and
  • a SourceInfoSchema cannot be derived from s,
  • or the detected variant of SourceInfo cannot be constructed from s.

type Err = Error

The Error type to use.

fn from_file(file: impl AsRef<Path>) -> Result<Self, Self::Err>

where Self: Sized,

Creates Self from file.

fn from_stdin() -> Result<Self, Self::Err>

where Self: Sized,

Creates Self from stdin.

fn from_stdin_with_schema(schema: Option<T>) -> Result<Self, Self::Err>

where Self: Sized,

Creates Self from stdin, optionally validated by a schema.

fn from_reader(reader: impl Read) -> Result<Self, Self::Err>

where Self: Sized,

Creates Self from a Read implementer.

impl PartialEq for SourceInfoSchema

fn eq(&self, other: &SourceInfoSchema) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<SchemaVersion> for SourceInfoSchema

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

Converts a SchemaVersion to a SourceInfoSchema.

Errors

Returns an error if the SchemaVersion’s inner Version does not provide a major version that corresponds to a SourceInfoSchema variant.

type Error = Error

The type returned in the event of a conversion error.

impl Eq for SourceInfoSchema

impl StructuralPartialEq for SourceInfoSchema