Enum Mtree

pub enum Mtree {
    V1(Vec<Path>),
    V2(Vec<Path>),
}

A representation of the ALPM-MTREE file format.

Tracks all available versions of the file format.

Variants

V1(Vec<Path>)

The ALPM-MTREEv1 file format.

V2(Vec<Path>)

The ALPM-MTREEv2 file format.

Implementations

impl Mtree

pub fn validate_paths( &self, input_paths: &InputPaths<'_, '_>, ) -> Result<(), Error>

Validates an InputPaths.

With input_pathsa set of relative paths and a common base directory is provided.

Each member of InputPaths::paths is compared with the data available in self by retrieving metadata from the on-disk files below InputPaths::base_dir. For this, MTREE_PATH_PREFIX is stripped from each Path tracked by the Mtree and afterwards each Path is compared with the respective file in InputPaths::base_dir. This includes checking if

• each relative path in InputPaths::paths matches a record in the ALPM-MTREE data,
• each relative path in InputPaths::paths relates to an existing file, directory or symlink in InputPaths::base_dir,
• the target of each symlink in the ALPM-MTREE data matches that of the corresponding on-disk file,
• size and SHA-256 hash digest of each file in the ALPM-MTREE data matches that of the corresponding on-disk file,
• the ALPM-MTREE data file itself is included in the ALPM-MTREE data,
• and the creation time, UID, GID and file mode of each file in the ALPM-MTREE data matches that of the corresponding on-disk file.

Errors

Returns an error if

• InputPaths::paths contains duplicates,
• or one of the ALPM-MTREE data entries
  • does not have a matching on-disk file, directory or symlink (depending on type),
  • has a mismatching symlink target from that of a corresponding on-disk file,
  • has a mismatching size or SHA-256 hash digest from that of a corresponding on-disk file,
  • is the ALPM-MTREE file,
  • or has a mismatching creation time, UID, GID or file mode from that of a corresponding on-disk file,
• or one of the file system paths in InputPaths::paths has no matching ALPM-MTREE entry.

Trait Implementations

impl Clone for Mtree

fn clone(&self) -> Mtree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mtree

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

Formats the value using the given formatter.

impl Display for Mtree

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

Formats the value using the given formatter.

impl FromStr for Mtree

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

Creates a Mtree from string slice s.

Calls Mtree::from_str_with_schema with schema set to None.

Errors

Returns an error if

• a MtreeSchema cannot be derived from s,
• or the detected variant of Mtree cannot be constructed from s.

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 Mtree

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

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 Mtree