Enum BuildInfo 

pub enum BuildInfo {
    V1(BuildInfoV1),
    V2(BuildInfoV2),
}

A representation of the BUILDINFO file format.

Tracks all available variants of the file format.

Variants

V1(BuildInfoV1)

The BUILDINFOv1 file format.

V2(BuildInfoV2)

The BUILDINFOv2 file format.

Trait Implementations

impl Clone for BuildInfo

fn clone(&self) -> BuildInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildInfo

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

Formats the value using the given formatter.

impl Display for BuildInfo

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

Formats the value using the given formatter.

impl FromStr for BuildInfo

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

Creates a BuildInfo from string slice s.

Calls BuildInfo::from_str_with_schema with schema set to None.

Errors

Returns an error if

• a BuildInfoSchema cannot be derived from s,
• or the detected variant of BuildInfo cannot be constructed from s.

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 = ccache
options = lto
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 = ccache
options = lto
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 = ccache
options = lto
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 = ccache
options = lto
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 BuildInfo

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BuildInfo