peace_cfg 0.0.15

Configuration model for the peace automation framework.
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

use std::marker::PhantomData;

use peace_item_model::ItemId;

#[cfg(feature = "output_progress")]
use peace_progress_model::ProgressSender;

/// References to pass information between the Peace framework and an item.
#[derive(Clone, Copy, Debug)]
pub struct FnCtx<'exec> {
    /// ID of the item this belongs to.
    pub item_id: &'exec ItemId,
    /// For items to submit progress updates.
    #[cfg(feature = "output_progress")]
    pub progress_sender: ProgressSender<'exec>,
    /// Marker.
    pub marker: PhantomData<&'exec ()>,
}

impl<'exec> FnCtx<'exec> {
    /// Returns a new `OpCtx`.
    pub fn new(
        item_id: &'exec ItemId,
        #[cfg(feature = "output_progress")] progress_sender: ProgressSender<'exec>,
    ) -> Self {
        Self {
            item_id,
            #[cfg(feature = "output_progress")]
            progress_sender,
            marker: PhantomData,
        }
    }

    /// Returns the `ProgressTracker` for items to send progress to.
    #[cfg(feature = "output_progress")]
    pub fn progress_sender(&self) -> &ProgressSender<'exec> {
        &self.progress_sender
    }
}