clawless-core 0.6.0

Types and traits for building command-line 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

use typed_fields::path;

use crate::context::ContextError;

path!(
    /// The working directory in which a command was called
    ///
    /// The current working directory is the directory from which Clawless commands are run. It is
    /// passed to commands via the `Context` struct, allowing commands to operate relative to this
    /// directory.
    ///
    /// Please note that the path is not updated if commands manually change into another directory.
    CurrentWorkingDirectory
);

impl CurrentWorkingDirectory {
    /// Creates a [`CurrentWorkingDirectory`] from the environment
    ///
    /// This function retrieves the current working directory from the environment and creates a
    /// [`CurrentWorkingDirectory`] instance. If the current directory cannot be determined, an error
    /// is returned.
    ///
    /// # Errors
    ///
    /// Returns [`std::io::Error`] if the current directory cannot be determined from the
    /// environment.
    pub fn try_from_env() -> Result<CurrentWorkingDirectory, ContextError> {
        let cwd = std::env::current_dir()?;
        Ok(CurrentWorkingDirectory::new(cwd))
    }
}