Struct FilesV1 

pub struct FilesV1(Vec<PathBuf>);

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

Tuple Fields

0: Vec<PathBuf>

Trait Implementations

impl AsRef<[PathBuf]> for FilesV1

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

Returns a reference to the inner Vec of PathBufs.

impl Clone for FilesV1

fn clone(&self) -> FilesV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilesV1

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

Formats the value using the given formatter.

impl FilesStyleToString for FilesV1

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

Returns the String representation of the FilesV1.

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

Examples

use std::path::PathBuf;

use alpm_files::{FilesStyle, FilesStyleToString, FilesV1};

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

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

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

// An empty alpm-repo-files.
let expected = "%FILES%\n";
let files = FilesV1::try_from(Vec::new())?;
assert_eq!(files.to_string(FilesStyle::Repo), expected);

// An alpm-repo-files with entries.
let expected = r#"%FILES%
usr/
usr/bin/
usr/bin/foo
"#;
let files = FilesV1::try_from(vec![
    PathBuf::from("usr/"),
    PathBuf::from("usr/bin/"),
    PathBuf::from("usr/bin/foo"),
])?;
assert_eq!(files.to_string(FilesStyle::Repo), expected);

impl FromStr for FilesV1

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

Creates a new FilesV1 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_files::FilesV1;
use winnow::Parser;

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

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

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

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

type Err = Error

The associated error which can be returned from parsing.

impl TryFrom<PathBuf> for FilesV1

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

Creates a new FilesV1 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 FilesV1 from this list.

Errors

Returns an error if

• alpm_common::relative_files fails,
• or TryFrom Vec of PathBuf for FilesV1 fails.

Examples

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

use alpm_files::FilesV1;
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 = FilesV1::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 FilesV1

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

Creates a new FilesV1 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_files::FilesV1;

let paths: Vec<PathBuf> = vec![
    PathBuf::from("usr/"),
    PathBuf::from("usr/bin/"),
    PathBuf::from("usr/bin/foo"),
];
let files = FilesV1::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!(FilesV1::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!(FilesV1::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!(FilesV1::try_from(paths).is_err());

type Error = Error

The type returned in the event of a conversion error.