Enum SourceInfo

pub enum SourceInfo {
    V1(SourceInfoV1),
}

The representation of SRCINFO data.

Tracks all available versions of the file format.

Variants

V1(SourceInfoV1)

Trait Implementations

impl Clone for SourceInfo

fn clone(&self) -> SourceInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for SourceInfo

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

Creates a SourceInfo from string slice s.

Calls SourceInfo::from_str_with_schema with schema set to None.

Errors

Returns an error if

• a SourceInfoSchema cannot be derived from s,
• or the detected variant of SourceInfo cannot be constructed from s.

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 Serialize for SourceInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.