kawauso-project 0.3.0

Projects for Kawauso applications
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

//! The directory at which the walk of a search starts

use typed_fields::path;

path!(
    /// The directory at which the walk of a search starts
    ///
    /// The search stores the value as the developer gave it. When the search
    /// runs, the value becomes a canonical path: a relative path resolves
    /// against the working directory of the process, the `.` and `..`
    /// components go, and the symbolic links resolve. The walk therefore
    /// never passes through a directory that the developer did not name.
    ///
    /// The value can name a file. The walk then starts at the directory that
    /// holds the file, because the project that governs a file is the project
    /// of that directory.
    ///
    /// An error that names the start shows it in the resolved form, because
    /// that is where the walk began. A start that the crate cannot read has
    /// no canonical path, and the error then shows the start as the developer
    /// gave it, resolved against the working directory.
    StartDirectory
);

/// Creates a start from a path that the application built at runtime
impl From<std::path::PathBuf> for StartDirectory {
    fn from(path: std::path::PathBuf) -> Self {
        Self::new(path)
    }
}

#[cfg(test)]
mod tests {
    // An assertion in a test panics by design. A `# Panics` section on every
    // test would repeat that and give the reader no information.
    #![allow(clippy::missing_panics_doc)]

    use super::*;

    // A path that the user names arrives as a `PathBuf`, and the start takes
    // it without a borrow.
    #[test]
    fn from_path_buf_keeps_the_path() {
        let start = StartDirectory::from(std::path::PathBuf::from("src"));

        assert_eq!(start.get(), std::path::Path::new("src"));
    }
}