xpct 0.5.1

An extensible test assertion library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

use std::fmt;
use std::path::Path;

use crate::core::Matcher;
use crate::matchers::files::{FileExistsMatcher, FileExistsMode};

use super::ExpectationFormat;

/// Succeeds when the actual value is the path of an existing file.
///
/// This follows symbolic links.
///
/// # Examples
///
/// ```no_run
/// use std::path::Path;
/// use xpct::{expect, be_existing_file};
///
/// expect!(Path::new("/path/to/file")).to(be_existing_file());
/// ```
pub fn be_existing_file<'a, Actual>() -> Matcher<'a, Actual, Actual>
where
    Actual: fmt::Debug + AsRef<Path> + 'a,
{
    Matcher::new(
        FileExistsMatcher::new(FileExistsMode::Exists),
        ExpectationFormat::new(
            "to exist in the filesystem",
            "to not exist in the filesystem",
        ),
    )
}

/// Succeeds when the actual value is the path of an existing regular file.
///
/// This follows symbolic links.
///
/// # Examples
///
/// ```no_run
/// use std::path::Path;
/// use xpct::{expect, be_regular_file};
///
/// expect!(Path::new("/path/to/regular/file")).to(be_regular_file());
/// ```
pub fn be_regular_file<'a, Actual>() -> Matcher<'a, Actual, Actual>
where
    Actual: fmt::Debug + AsRef<Path> + 'a,
{
    Matcher::new(
        FileExistsMatcher::new(FileExistsMode::RegularFile),
        ExpectationFormat::new("to exist and be a regular file", "to not be a regular file"),
    )
}

/// Succeeds when the actual value is the path of an existing directory.
///
/// This follows symbolic links.
///
/// # Examples
///
/// ```no_run
/// use std::path::Path;
/// use xpct::{expect, be_directory};
///
/// expect!(Path::new("/path/to/directory")).to(be_directory());
/// ```
pub fn be_directory<'a, Actual>() -> Matcher<'a, Actual, Actual>
where
    Actual: fmt::Debug + AsRef<Path> + 'a,
{
    Matcher::new(
        FileExistsMatcher::new(FileExistsMode::Directory),
        ExpectationFormat::new("to exist and be a directory", "to not be a directory"),
    )
}

/// Succeeds when the actual value is the path of an existing symbolic link.
///
/// # Examples
///
/// ```no_run
/// use std::path::Path;
/// use xpct::{expect, be_symlink};
///
/// expect!(Path::new("/path/to/symlink")).to(be_symlink());
/// ```
pub fn be_symlink<'a, Actual>() -> Matcher<'a, Actual, Actual>
where
    Actual: fmt::Debug + AsRef<Path> + 'a,
{
    Matcher::new(
        FileExistsMatcher::new(FileExistsMode::Symlink),
        ExpectationFormat::new(
            "to exist and be a symbolic link",
            "to not be a symbolic link",
        ),
    )
}