Struct DbFilesV1 

pub struct DbFilesV1 {
    files: Vec<PathBuf>,
    backup: Vec<BackupEntry>,
}

The representation of alpm-db-files data (version 1).

Fields

files: Vec<PathBuf>

backup: Vec<BackupEntry>

Implementations

impl DbFilesV1

pub fn backups(&self) -> &[BackupEntry]

Returns the backup entries tracked for this file listing.

fn try_from_parts( paths: Vec<PathBuf>, backup: Vec<BackupEntry>, ) -> Result<Self, Error>

Trait Implementations

impl AsRef<[PathBuf]> for DbFilesV1

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

Returns a reference to the inner Vec of PathBufs.

impl Clone for DbFilesV1

fn clone(&self) -> DbFilesV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DbFilesV1

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

Formats the value using the given formatter.

impl Display for DbFilesV1

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

Returns the String representation of the DbFilesV1.

Examples

use std::path::PathBuf;

use alpm_db::files::DbFilesV1;

// An empty alpm-db-files.
let expected = "";
let files = DbFilesV1::try_from(Vec::new())?;
assert_eq!(files.to_string(), expected);

// An alpm-db-files with entries.
let expected = r#"%FILES%
usr/
usr/bin/
usr/bin/foo

"#;
let files = DbFilesV1::try_from(vec![
    PathBuf::from("usr/"),
    PathBuf::from("usr/bin/"),
    PathBuf::from("usr/bin/foo"),
])?;
assert_eq!(files.to_string(), expected);

impl FromStr for DbFilesV1

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

Creates a new DbFilesV1 from a string slice.

Note

Delegates to the TryFrom Vec of PathBuf implementation, after the string slice has been parsed as a Vec of PathBuf.

Errors

Returns an error, if

• value is not empty and the first line does not contain the section header (“%FILES%”),
• there are lines following the section header, but they cannot be parsed as a Vec of PathBuf,
• or Self::try_from Vec of PathBuf fails.

Examples

use std::{path::PathBuf, str::FromStr};

use alpm_db::files::DbFilesV1;
use winnow::Parser;

// No files according to alpm-db-files.
let data = "";
let files = DbFilesV1::from_str(data)?;

// No files according to alpm-db-files.
let data = "%FILES%";
let files = DbFilesV1::from_str(data)?;
let data = "%FILES%\n";
let files = DbFilesV1::from_str(data)?;

// DbFiles according to alpm-db-files.
let data = r#"%FILES%
usr/
usr/bin/
usr/bin/foo"#;
let files = DbFilesV1::from_str(data)?;

// DbFiles according to alpm-db-files.
let data = r#"%FILES%
usr/
usr/bin/
usr/bin/foo
"#;
let files = DbFilesV1::from_str(data)?;

type Err = Error

The associated error which can be returned from parsing.

impl Serialize for DbFilesV1

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<(Vec<PathBuf>, Vec<BackupEntry>)> for DbFilesV1

fn try_from( value: (Vec<PathBuf>, Vec<BackupEntry>), ) -> Result<Self, Self::Error>

Creates a new DbFilesV1 from a Vec of PathBuf and backup entries.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<PathBuf> for DbFilesV1

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

Creates a new DbFilesV1 from all files and directories in a directory.

Note

Delegates to [alpm_common::relative_files] to get a sorted list of all files and directories in the directory value (relative to value). Afterwards, tries to construct a DbFilesV1 from this list.

Errors

Returns an error if

• [alpm_common::relative_files] fails,
• or TryFrom Vec of PathBuf for DbFilesV1 fails.

Examples

use std::{
    fs::{File, create_dir_all},
    path::PathBuf,
};

use alpm_db::files::DbFilesV1;
use tempfile::tempdir;

let temp_dir = tempdir()?;
let path = temp_dir.path();
create_dir_all(path.join("usr/bin/"))?;
File::create(path.join("usr/bin/foo"))?;

let files = DbFilesV1::try_from(path.to_path_buf())?;
assert_eq!(
    files.as_ref(),
    vec![
        PathBuf::from("usr/"),
        PathBuf::from("usr/bin/"),
        PathBuf::from("usr/bin/foo")
    ]
);

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<Vec<PathBuf>> for DbFilesV1

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

Creates a new DbFilesV1 from a Vec of PathBuf.

The provided value is sorted and checked for non top-level paths without a parent, as well as any duplicate paths.

Errors

Returns an error if

• value contains absolute paths,
• value contains (non top-level) paths without a parent directory present in value,
• or value contains duplicate paths.

Examples

use std::path::PathBuf;

use alpm_db::files::DbFilesV1;

let paths: Vec<PathBuf> = vec![
    PathBuf::from("usr/"),
    PathBuf::from("usr/bin/"),
    PathBuf::from("usr/bin/foo"),
];
let files = DbFilesV1::try_from(paths)?;

// Absolute paths are not allowed.
let paths: Vec<PathBuf> = vec![
    PathBuf::from("/usr/"),
    PathBuf::from("/usr/bin/"),
    PathBuf::from("/usr/bin/foo"),
];
assert!(DbFilesV1::try_from(paths).is_err());

// Every path (excluding top-level paths) must have a parent.
let paths: Vec<PathBuf> = vec![PathBuf::from("usr/bin/"), PathBuf::from("usr/bin/foo")];
assert!(DbFilesV1::try_from(paths).is_err());

// Every path must be unique.
let paths: Vec<PathBuf> = vec![
    PathBuf::from("usr/"),
    PathBuf::from("usr/"),
    PathBuf::from("usr/bin/"),
    PathBuf::from("usr/bin/foo"),
];
assert!(DbFilesV1::try_from(paths).is_err());

type Error = Error

The type returned in the event of a conversion error.