planif 1.0.0

planif is a builder pattern wrapper for the windows task scheduler API of windows-rs.
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

use windows::core::BSTR;
use windows::Win32::System::TaskScheduler::{
    IActionCollection, IRegistrationInfo, ITaskDefinition, ITaskFolder, ITaskService,
    ITaskSettings, ITrigger, ITriggerCollection, TASK_LOGON_INTERACTIVE_TOKEN,
};
use windows::Win32::System::Com::VARIANT;

use crate::com::ComRuntime;

#[derive(Debug, PartialEq)]
/// A schedule is created by a [schedule builder](crate::schedule_builder). Once created, the
/// Schedule can be registered with the Windows Task Scheduler.
pub struct Schedule {
    pub(crate) task_folder: ITaskFolder,
    pub(crate) actions: IActionCollection,
    pub(crate) force_start_boundary: bool,
    pub(crate) registration_info: IRegistrationInfo,
    pub(crate) settings: ITaskSettings,
    pub(crate) task_definition: ITaskDefinition,
    pub(crate) task_service: ITaskService,
    pub(crate) trigger: Option<ITrigger>,
    pub(crate) triggers: ITriggerCollection,
    //repetition: IRepetitionPattern,
}

impl Schedule {
    /// Registers the schedule. Flags can be set by using the [TaskCreationFlags](crate::enums::TaskCreationFlags) enum.
    pub fn register(self, task_name: &str, flags: i32) -> Result<(), Box<dyn std::error::Error>> {
        unsafe {
            self.task_folder.RegisterTaskDefinition(
                &BSTR::from(task_name),
                &self.task_definition,
                flags,
                // TODO allow user to specify creds
                VARIANT::default(),
                VARIANT::default(),
                TASK_LOGON_INTERACTIVE_TOKEN,
                VARIANT::default(),
            )?;
        }

        Ok(())
    }
}

/// TaskScheduler represents the actions you can take for using the Windows Task Scheduler.
/// For example: Creating new schedules, fetching the COM, etc.
pub struct TaskScheduler {
    com: ComRuntime
}

impl TaskScheduler {
    /// Create's a new TaskScheduler
    /// # Example
    /// ```
    /// use planif::schedule::TaskScheduler;
    ///
    /// let ts = TaskScheduler::new().unwrap();
    /// ```
    ///
    pub fn new() -> Result<Self, Box<dyn std::error::Error>> {
        Ok(Self {
            com: ComRuntime::new()?
        })
    }

    /// Returns the TaskScheduler's com runtime
    /// # Example
    /// ```
    /// use planif::schedule::TaskScheduler;
    /// 
    /// let ts = TaskScheduler::new().unwrap();
    /// let com = ts.get_com();
    /// ```
    pub fn get_com(&self) -> ComRuntime {
        self.com.clone()
    }
}