Struct FilePath 

pub struct FilePath {
    pub path: Vec<PathComponent>,
}

A file path. A file path specifies a target file. It may consist of multiple path components. Imagine the following file structure:

DIR stuff
\-- DIR more_stuff
  \-- FILE archive.tar.gz
    \-- FILE file_in_archive.txt

The file path to file_in_archive.txt would consist of the following path components:

• stuff/more_stuff/archive.tar.gz (target: Archive)
• file_in_archive.txt (target: File)

The file path to archive.tar.gz would consist of the following path components:

• stuff/more_stuff/archive.tar.gz (target: File)

Fields

• path - The path components.

Examples

use std::path::PathBuf;
use backup_deduplicator::path::FilePath;

let path = FilePath::from_realpath(PathBuf::from("test.txt"));

Fields

path: Vec<PathComponent>

Implementations

impl FilePath

pub fn from_pathcomponents(path: Vec<PathComponent>) -> Self

Creates a new file path from path components.

Arguments

• path - The path components.

Returns

The file path.

pub fn from_realpath(path: PathBuf) -> Self

Creates a new file path from a real path.

Arguments

• path - The real path.

Returns

The file path.

pub fn join_realpath(&mut self, _path: PathBuf)

pub fn extract_parent(&self, _temp_directory: &PathBuf)

pub fn delete_parent(&self, _temp_directory: &PathBuf)

pub fn resolve_file(&self) -> Result<PathBuf>

Resolves the file path to a single file.

Returns

The resolved file path.

Errors

Never

pub fn child<Str: Into<OsString>>(&self, child_name: Str) -> FilePath

Gets the child of where the file path points to.

Arguments

• child_name - The name of the child.

Returns

The child file path.

Example

use std::path::PathBuf;
use backup_deduplicator::path::FilePath;

let path = FilePath::from_realpath(PathBuf::from("test/"));
let child = path.child("child.txt");

assert_eq!(child.path[0].path, PathBuf::from("test/child.txt"));
assert_eq!(child.path.len(), 1);

use std::path::PathBuf;
use backup_deduplicator::path::FilePath;

let path = FilePath::from_realpath(PathBuf::from("test/"));
let subpath = path.child("subdir").child("abc.txt");

assert_eq!(subpath.path[0].path, PathBuf::from("test/subdir/abc.txt"));
assert_eq!(subpath.path.len(), 1);

pub fn parent(&self) -> Option<FilePath>

Gets the parent of the file path.

Returns

The parent file path. None if the file path has no parent.

Example

use std::path::PathBuf;
use backup_deduplicator::path::FilePath;

let path = FilePath::from_realpath(PathBuf::from("test/abc/def.txt"));
let parent = path.parent().unwrap();

assert_eq!(parent.path[0].path, PathBuf::from("test/abc"));

//                      test/abc          test/             ""        None
let root = path.parent().unwrap().parent().unwrap().parent().unwrap().parent();

assert_eq!(root, None);

Trait Implementations

impl Clone for FilePath

fn clone(&self) -> FilePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilePath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FilePath

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FilePath

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

Formats the file path to a string.

impl Hash for FilePath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FilePath

fn eq(&self, other: &Self) -> bool

Compares two file paths.

Arguments

• other - The other file path.

Returns

Whether the file paths are equal.

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 FilePath

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FilePath