Enum Files 

pub enum Files {
    V1(FilesV1),
}

The representation of alpm-files data.

Tracks all known versions of the specification.

Variants

V1(FilesV1)

Version 1 of the alpm-files specification.

Trait Implementations

impl AsRef<[PathBuf]> for Files

fn as_ref(&self) -> &[PathBuf]

Returns a reference to the inner Vec of PathBufs.

impl Clone for Files

fn clone(&self) -> Files

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Files

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

Formats the value using the given formatter.

impl FilesStyleToString for Files

fn to_string(&self, format: FilesStyle) -> String

Returns the String representation of the Files.

The formatting of the returned string depends on the provided FilesStyle.

impl FromStr for Files

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

Creates a new Files from string slice.

Note

Delegates to Self::from_str_with_schema while not providing a FilesSchema.

Errors

Returns an error if Self::from_str_with_schema fails.

type Err = Error

The associated error which can be returned from parsing.

impl MetadataFile<FilesSchema> for Files

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

where Self: Sized,

Creates a new Files from a file Path and an optional FilesSchema.

Note

Delegates to Self::from_reader_with_schema after opening file for reading.

Errors

Returns an error if

• the file cannot be opened for reading,
• or Self::from_reader_with_schema fails.

Examples

use std::io::Write;

use alpm_common::MetadataFile;
use alpm_files::{Files, FilesSchema};
use alpm_types::{SchemaVersion, semver_version::Version};
use tempfile::NamedTempFile;

let data = r#"%FILES%
usr/
usr/bin/
usr/bin/foo
"#;
let mut temp_file = NamedTempFile::new()?;
write!(temp_file, "{data}")?;
let files = Files::from_file_with_schema(
    temp_file.path(),
    Some(FilesSchema::V1(SchemaVersion::new(Version::new(1, 0, 0)))),
)?;
matches!(files, Files::V1(_));
assert_eq!(files.as_ref().len(), 3);

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

where Self: Sized,

Creates a new Files from a Read implementation and an optional FilesSchema.

Note

Delegates to Self::from_str_with_schema after reading reader to string.

Errors

Returns an error if

• the reader cannot be read to string,
• or Self::from_str_with_schema fails.

Examples

use std::io::{Seek, SeekFrom, Write};

use alpm_common::MetadataFile;
use alpm_files::{Files, FilesSchema};
use alpm_types::{SchemaVersion, semver_version::Version};
use tempfile::tempfile;

let data = r#"%FILES%
usr/
usr/bin/
usr/bin/foo
"#;
let mut temp_file = tempfile()?;
write!(temp_file, "{data}")?;
temp_file.seek(SeekFrom::Start(0))?;
let files = Files::from_reader_with_schema(
    temp_file,
    Some(FilesSchema::V1(SchemaVersion::new(Version::new(1, 0, 0)))),
)?;
matches!(files, Files::V1(_));
assert_eq!(files.as_ref().len(), 3);

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

where Self: Sized,

Creates a new Files from a string slice and an optional FilesSchema.

Errors

Returns an error if

• schema is None and a FilesSchema cannot be derived from s,
• or a FilesV1 cannot be created from s.

Examples

use alpm_common::MetadataFile;
use alpm_files::{Files, FilesSchema};
use alpm_types::{SchemaVersion, semver_version::Version};

let data = r#"%FILES%
usr/
usr/bin/
usr/bin/foo
"#;
let files = Files::from_str_with_schema(
    data,
    Some(FilesSchema::V1(SchemaVersion::new(Version::new(1, 0, 0)))),
)?;
matches!(files, Files::V1(_));
assert_eq!(files.as_ref().len(), 3);

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.