Enum MtreeSchema

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

An enum tracking all available ALPM-MTREE schemas.

The schema of a ALPM-MTREE refers to its available fields in a specific version.

Variants

V1(SchemaVersion)

V2(SchemaVersion)

Trait Implementations

impl Clone for MtreeSchema

fn clone(&self) -> MtreeSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MtreeSchema

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

Formats the value using the given formatter.

impl Default for MtreeSchema

fn default() -> Self

Returns the default MtreeSchema variant (MtreeSchema::V2).

impl Display for MtreeSchema

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

Formats the value using the given formatter.

impl FileFormatSchema for MtreeSchema

fn inner(&self) -> &SchemaVersion

Returns a reference to the inner SchemaVersion.

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

where Self: Sized,

Derives an MtreeSchema from an ALPM-MTREE file.

Opens the file and defers to MtreeSchema::derive_from_reader.

Errors

Returns an error if

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

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

where Self: Sized,

Derives an MtreeSchema from ALPM-MTREE data in a reader.

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

Errors

Returns an error if

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

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

Derives an MtreeSchema from a string slice containing ALPM-MTREE data.

Since the ALPM-MTREE format does not carry any version information, this function checks whether s contains md5= or md5digest=. If it does, the input is considered to be ALPM-MTREEv2. If the strings are not found, ALPM-MTREEv1 is assumed.

Examples

use alpm_common::FileFormatSchema;
use alpm_mtree::MtreeSchema;
use alpm_types::{SchemaVersion, semver_version::Version};

let mtree_v2 = r#"
#mtree
/set mode=644 uid=0 gid=0 type=file
./some_file time=1700000000.0 size=1337 sha256digest=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
./some_link type=link link=some_file time=1700000000.0
./some_dir type=dir time=1700000000.0
"#;
assert_eq!(
    MtreeSchema::V2(SchemaVersion::new(Version::new(2, 0, 0))),
    MtreeSchema::derive_from_str(mtree_v2)?
);

let mtree_v1 = r#"
#mtree
/set mode=644 uid=0 gid=0 type=file
./some_file time=1700000000.0 size=1337 sha256digest=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef md5digest=d3b07384d113edec49eaa6238ad5ff00
./some_link type=link link=some_file time=1700000000.0
./some_dir type=dir time=1700000000.0
"#;
assert_eq!(
    MtreeSchema::V1(SchemaVersion::new(Version::new(1, 0, 0))),
    MtreeSchema::derive_from_str(mtree_v1)?
);

Errors

Returns an error if

• the first xdata keyword is assigned an empty string,
• or the first xdata keyword does not assign “pkgtype”.

type Err = Error

The Error type to use.

impl From<BsdtarOptions> for MtreeSchema

fn from(value: BsdtarOptions) -> Self

Creates an MtreeSchema from a BsdtarOptions

impl FromStr for MtreeSchema

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

Creates an MtreeSchema from string slice s.

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

Errors

Returns an error if

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

type Err = Error

The associated error which can be returned from parsing.

impl MetadataFile<MtreeSchema> for Mtree

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

Creates a Mtree from file, optionally validated using a MtreeSchema.

Opens the file and defers to Mtree::from_reader_with_schema.

Note

To automatically derive the MtreeSchema, use Mtree::from_file.

Examples

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

use alpm_common::{FileFormatSchema, MetadataFile};
use alpm_mtree::{Mtree, MtreeSchema};
use alpm_types::{SchemaVersion, semver_version::Version};

// Prepare a file with ALPM-MTREE data
let file = {
    let mtree_data = r#"#mtree
/set mode=644 uid=0 gid=0 type=file
./some_file time=1700000000.0 size=1337 sha256digest=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
./some_link type=link link=some_file time=1700000000.0
./some_dir type=dir time=1700000000.0
"#;
    let mtree_file = tempfile::NamedTempFile::new()?;
    let mut output = File::create(&mtree_file)?;
    write!(output, "{}", mtree_data)?;
    mtree_file
};

let mtree = Mtree::from_file_with_schema(
    file.path().to_path_buf(),
    Some(MtreeSchema::V2(SchemaVersion::new(Version::new(2, 0, 0)))),
)?;

Errors

Returns an error if

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

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

Creates a Mtree from a reader, optionally validated using a MtreeSchema.

Reads the reader to string (and decompresses potentially gzip compressed data on-the-fly). Then defers to Mtree::from_str_with_schema.

Note

To automatically derive the MtreeSchema, use Mtree::from_reader.

Examples

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

use alpm_common::MetadataFile;
use alpm_mtree::{Mtree, MtreeSchema};
use alpm_types::{SchemaVersion, semver_version::Version};

// Prepare a reader with ALPM-MTREE data
let reader = {
    let mtree_data = r#"#mtree
/set mode=644 uid=0 gid=0 type=file
./some_file time=1700000000.0 size=1337 sha256digest=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
./some_link type=link link=some_file time=1700000000.0
./some_dir type=dir time=1700000000.0
"#;
    let mtree_file = tempfile::NamedTempFile::new()?;
    let mut output = File::create(&mtree_file)?;
    write!(output, "{}", mtree_data)?;
    File::open(&mtree_file.path())?
};

let mtree = Mtree::from_reader_with_schema(
    reader,
    Some(MtreeSchema::V2(SchemaVersion::new(Version::new(2, 0, 0)))),
)?;

Errors

Returns an error if

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

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

Creates a Mtree from string slice, optionally validated using a MtreeSchema.

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

Note

To automatically derive the MtreeSchema, use Mtree::from_str.

Examples

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

use alpm_common::MetadataFile;
use alpm_mtree::{Mtree, MtreeSchema};
use alpm_types::{SchemaVersion, semver_version::Version};

let mtree_v2 = r#"
#mtree
/set mode=644 uid=0 gid=0 type=file
./some_file time=1700000000.0 size=1337 sha256digest=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
./some_link type=link link=some_file time=1700000000.0
./some_dir type=dir time=1700000000.0
"#;
let mtree = Mtree::from_str_with_schema(
    mtree_v2,
    Some(MtreeSchema::V2(SchemaVersion::new(Version::new(2, 0, 0)))),
)?;

let mtree_v1 = r#"
#mtree
/set mode=644 uid=0 gid=0 type=file
./some_file time=1700000000.0 size=1337 sha256digest=0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef md5digest=d3b07384d113edec49eaa6238ad5ff00
./some_link type=link link=some_file time=1700000000.0
./some_dir type=dir time=1700000000.0
"#;
let mtree = Mtree::from_str_with_schema(
    mtree_v1,
    Some(MtreeSchema::V1(SchemaVersion::new(Version::new(1, 0, 0)))),
)?;

Errors

Returns an error if

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

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

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

Converts a SchemaVersion to an MtreeSchema.

Errors

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

type Error = Error

The type returned in the event of a conversion error.

impl Eq for MtreeSchema

impl StructuralPartialEq for MtreeSchema