Enum FilesSchema 

pub enum FilesSchema {
    V1(SchemaVersion),
}

A schema for the alpm-files format.

Variants

V1(SchemaVersion)

Version 1 of the alpm-files specification.

Trait Implementations

impl Clone for FilesSchema

fn clone(&self) -> FilesSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilesSchema

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

Formats the value using the given formatter.

impl Default for FilesSchema

fn default() -> Self

Returns the default schema variant (FilesSchema::V1).

impl FileFormatSchema for FilesSchema

fn inner(&self) -> &SchemaVersion

Returns a reference to the inner SchemaVersion.

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

where Self: Sized,

Creates a new FilesSchema from a file Path.

Note

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

Errors

Returns an error if

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

Examples

use std::io::Write;

use alpm_common::FileFormatSchema;
use alpm_files::FilesSchema;
use tempfile::NamedTempFile;

let data = r#"%FILES%
usr/
usr/bin/
usr/bin/foo
"#;
let mut temp_file = NamedTempFile::new()?;
write!(temp_file, "{data}");
let schema = FilesSchema::derive_from_file(temp_file.path())?;
matches!(schema, FilesSchema::V1(_));

// Empty inputs may also be considered as a schema
let mut temp_file = NamedTempFile::new()?;
let schema = FilesSchema::derive_from_file(temp_file.path())?;
matches!(schema, FilesSchema::V1(_));

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

where Self: Sized,

Creates a new FilesSchema from a Read implementation.

Note

Delegates to Self::derive_from_str after reading the reader to string.

Errors

Returns an error if

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

Examples

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

use alpm_common::FileFormatSchema;
use alpm_files::FilesSchema;
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 schema = FilesSchema::derive_from_reader(temp_file)?;
matches!(schema, FilesSchema::V1(_));

// Empty inputs may also be considered as a schema
let mut temp_file = tempfile()?;
let schema = FilesSchema::derive_from_reader(temp_file)?;
matches!(schema, FilesSchema::V1(_));

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

where Self: Sized,

Creates a new FilesSchema from a string slice.

Errors

Returns an error if

• a FilesSchema cannot be derived from s,
• or a FilesV1 cannot be created from s.

Examples

use alpm_common::FileFormatSchema;
use alpm_files::FilesSchema;

let data = r#"%FILES%
usr/
usr/bin/
usr/bin/foo
"#;
let schema = FilesSchema::derive_from_str(data)?;
matches!(schema, FilesSchema::V1(_));

// Empty inputs may also be considered as a schema
let data = "";
let schema = FilesSchema::derive_from_str(data)?;
matches!(schema, FilesSchema::V1(_));

type Err = Error

The Error type to use.

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.

impl PartialEq for FilesSchema

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

impl StructuralPartialEq for FilesSchema