Enum BuildInfoSchema

pub enum BuildInfoSchema {
    V1(SchemaVersion),
    V2(SchemaVersion),
}

An enum describing all valid BUILDINFO schemas

Variants

V1(SchemaVersion)

V2(SchemaVersion)

Trait Implementations

impl Clone for BuildInfoSchema

fn clone(&self) -> BuildInfoSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BuildInfoSchema

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

Formats the value using the given formatter.

impl Default for BuildInfoSchema

fn default() -> Self

Returns the default BuildInfoSchema variant (BuildInfoSchema::V2)

impl Display for BuildInfoSchema

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

Formats the value using the given formatter.

impl FileFormatSchema for BuildInfoSchema

fn inner(&self) -> &SchemaVersion

Returns the schema version

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

where Self: Sized,

Derives a BuildInfoSchema from a BUILDINFO file.

Opens the file and defers to BuildInfoSchema::derive_from_reader.

Errors

Returns an error if

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

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

where Self: Sized,

Derives a BuildInfoSchema from BUILDINFO data in a reader.

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

Errors

Returns an error if

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

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

Derives a BuildInfoSchema from a string slice containing BUILDINFO data.

Relies on the format keyword and its assigned value in the BUILDINFO data to derive a corresponding BuildInfoSchema.

Examples

use alpm_buildinfo::BuildInfoSchema;
use alpm_common::FileFormatSchema;
use alpm_types::{SchemaVersion, semver_version::Version};

let buildinfo_v2 = r#"builddate = 1
builddir = /build
startdir = /startdir
buildtool = devtools
buildtoolver = 1:1.2.1-1-any
buildenv = envfoo
format = 2
installed = bar-1.2.3-1-any
options = some_option
packager = Foobar McFooface <foobar@mcfooface.org>
pkgarch = any
pkgbase = foo
pkgbuild_sha256sum = b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
pkgname = foo
pkgver = 1:1.0.0-1"#;

assert_eq!(
    BuildInfoSchema::V2(SchemaVersion::new(Version::new(2, 0, 0))),
    BuildInfoSchema::derive_from_str(buildinfo_v2)?
);

let buildinfo_v1 = r#"builddate = 1
builddir = /build
startdir = /startdir
buildenv = envfoo
format = 1
installed = bar-1.2.3-1-any
options = some_option
packager = Foobar McFooface <foobar@mcfooface.org>
pkgarch = any
pkgbase = foo
pkgbuild_sha256sum = b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
pkgname = foo
pkgver = 1:1.0.0-1"#;

assert_eq!(
    BuildInfoSchema::V1(SchemaVersion::new(Version::new(1, 0, 0))),
    BuildInfoSchema::derive_from_str(buildinfo_v1)?
);

Errors

Returns an error if

• the format field is missing from s
• or deriving a BuildInfoSchema from format field fails.

type Err = Error

The Error type to use.

impl FromStr for BuildInfoSchema

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

Creates a BuildInfoSchema from string slice s.

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

Errors

Returns an error if

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

type Err = Error

The associated error which can be returned from parsing.

impl MetadataFile<BuildInfoSchema> for BuildInfo

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

Creates a BuildInfo from file, optionally validated using a BuildInfoSchema.

Opens the file and defers to BuildInfo::from_reader_with_schema.

Note

To automatically derive the BuildInfoSchema, use BuildInfo::from_file.

Examples

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

use alpm_buildinfo::{BuildInfo, BuildInfoSchema};
use alpm_common::{FileFormatSchema, MetadataFile};
use alpm_types::{SchemaVersion, semver_version::Version};

// Prepare a file with BUILDINFO data
let (file, buildinfo_data) = {
    let buildinfo_data = r#"format = 2
pkgname = foo
pkgbase = foo
pkgver = 1:1.0.0-1
pkgarch = any
pkgbuild_sha256sum = b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
packager = Foobar McFooface <foobar@mcfooface.org>
builddate = 1
builddir = /build
startdir = /startdir/
buildtool = devtools
buildtoolver = 1:1.2.1-1-any
buildenv = envfoo
options = some_option
installed = bar-1.2.3-1-any
"#;
    let file = tempfile::NamedTempFile::new()?;
    let mut output = File::create(&file)?;
    write!(output, "{}", buildinfo_data)?;
    (file, buildinfo_data)
};

let buildinfo = BuildInfo::from_file_with_schema(
    file.path(),
    Some(BuildInfoSchema::V2(SchemaVersion::new(Version::new(
        2, 0, 0,
    )))),
)?;
assert_eq!(buildinfo.to_string(), buildinfo_data);

Errors

Returns an error if

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

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

Creates a BuildInfo from a reader, optionally validated using a BuildInfoSchema.

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

Note

To automatically derive the BuildInfoSchema, use BuildInfo::from_reader.

Examples

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

use alpm_buildinfo::{BuildInfo, BuildInfoSchema};
use alpm_common::MetadataFile;
use alpm_types::{SchemaVersion, semver_version::Version};

// Prepare a reader with BUILDINFO data
let (reader, buildinfo_data) = {
    let buildinfo_data = r#"format = 2
pkgname = foo
pkgbase = foo
pkgver = 1:1.0.0-1
pkgarch = any
pkgbuild_sha256sum = b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
packager = Foobar McFooface <foobar@mcfooface.org>
builddate = 1
builddir = /build
startdir = /startdir/
buildtool = devtools
buildtoolver = 1:1.2.1-1-any
buildenv = envfoo
options = some_option
installed = bar-1.2.3-1-any
"#;
    let buildinfo_file = tempfile::NamedTempFile::new()?;
    let mut output = File::create(&buildinfo_file)?;
    write!(output, "{}", buildinfo_data)?;
    (File::open(&buildinfo_file.path())?, buildinfo_data)
};

let buildinfo = BuildInfo::from_reader_with_schema(
    reader,
    Some(BuildInfoSchema::V2(SchemaVersion::new(Version::new(
        2, 0, 0,
    )))),
)?;
assert_eq!(buildinfo.to_string(), buildinfo_data);

Errors

Returns an error if

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

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

Creates a BuildInfo from string slice, optionally validated using a BuildInfoSchema.

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

Note

To automatically derive the BuildInfoSchema, use BuildInfo::from_str.

Examples

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

use alpm_buildinfo::{BuildInfo, BuildInfoSchema};
use alpm_common::MetadataFile;
use alpm_types::{SchemaVersion, semver_version::Version};

let buildinfo_v2_data = r#"format = 2
pkgname = foo
pkgbase = foo
pkgver = 1:1.0.0-1
pkgarch = any
pkgbuild_sha256sum = b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
packager = Foobar McFooface <foobar@mcfooface.org>
builddate = 1
builddir = /build
startdir = /startdir/
buildtool = devtools
buildtoolver = 1:1.2.1-1-any
buildenv = envfoo
options = some_option
installed = bar-1.2.3-1-any
"#;

let buildinfo_v2 = BuildInfo::from_str_with_schema(
    buildinfo_v2_data,
    Some(BuildInfoSchema::V2(SchemaVersion::new(Version::new(
        2, 0, 0,
    )))),
)?;
assert_eq!(buildinfo_v2.to_string(), buildinfo_v2_data);

let buildinfo_v1_data = r#"format = 1
pkgname = foo
pkgbase = foo
pkgver = 1:1.0.0-1
pkgarch = any
pkgbuild_sha256sum = b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
packager = Foobar McFooface <foobar@mcfooface.org>
builddate = 1
builddir = /build
buildenv = envfoo
options = some_option
installed = bar-1.2.3-1-any
"#;

let buildinfo_v1 = BuildInfo::from_str_with_schema(
    buildinfo_v1_data,
    Some(BuildInfoSchema::V1(SchemaVersion::new(Version::new(
        1, 0, 0,
    )))),
)?;
assert_eq!(buildinfo_v1.to_string(), buildinfo_v1_data);

Errors

Returns an error if

• schema is Some and the specified variant of BuildInfo cannot be constructed from s,
• schema is None and
  • a BuildInfoSchema cannot be derived from s,
  • or the detected variant of BuildInfo 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 BuildInfoSchema

fn eq(&self, other: &BuildInfoSchema) -> 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 BuildInfoSchema

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

Converts a SchemaVersion to a BuildInfoSchema.

Errors

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

type Error = Error

The type returned in the event of a conversion error.

impl Eq for BuildInfoSchema

impl StructuralPartialEq for BuildInfoSchema