clawless 0.5.0

An opinionated framework 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
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

//! Context for Clawless commands
//!
//! This module defines the `Context` struct, which provides information about the environment that
//! Clawless commands are executed in, access to shared resources like loggers, and configuration
//! settings.
//!
//! For information on the context that is available to commands, see the fields and methods of the
//! `Context` struct as well as the types defined in this module.

use anyhow::Result;
use getset::Getters;
use typed_builder::TypedBuilder;

pub use self::current_working_directory::CurrentWorkingDirectory;
use crate::cancellation::Cancellation;

mod current_working_directory;

/// Context for Clawless commands
///
/// This struct provides information about the environment that Clawless commands are executed in,
/// access to shared resources, and configuration settings. It is passed to each command by the
/// Clawless runtime when executing commands.
///
/// ```rust,ignore
/// #[derive(Debug, Args)]
/// pub struct GreetArgs {
///     name: String,
/// }
///
/// #[command]
/// pub async fn greet(args: GreetArgs, context: Context) -> CommandResult {
///     println!("Hello, {}!", args.name);
///     Ok(())
/// }
/// ```
#[derive(Clone, Debug, Getters, TypedBuilder)]
pub struct Context {
    /// The working directory in which a command was called
    #[builder(setter(into))]
    #[getset(get = "pub")]
    current_working_directory: CurrentWorkingDirectory,

    /// The cancellation token for cooperative shutdown
    #[builder(default)]
    #[getset(get = "pub")]
    cancellation: Cancellation,
}

impl Context {
    /// Create a new `Context` instance
    ///
    /// This function initializes a new `Context` with default settings. Since some parts of the
    /// context might fail to initialize, this function returns a [`Result`].
    ///
    /// # Errors
    ///
    /// Returns an error if the current working directory cannot be determined.
    ///
    /// [`Result`]: anyhow::Result
    pub fn try_new(cancellation: Cancellation) -> Result<Self> {
        let current_working_directory = CurrentWorkingDirectory::try_from_env()?;

        Ok(Self {
            current_working_directory,
            cancellation,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn trait_send() {
        fn assert_send<T: Send>() {}
        assert_send::<Context>();
    }

    #[test]
    fn trait_sync() {
        fn assert_sync<T: Sync>() {}
        assert_sync::<Context>();
    }

    #[test]
    fn trait_unpin() {
        fn assert_unpin<T: Unpin>() {}
        assert_unpin::<Context>();
    }
}