peace_data 0.0.15

Data 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
40
41
42
43
44
45
46
47
48
49
50
51
52
53

use std::fmt::Debug;

use fn_graph::{DataAccess, DataAccessDyn, DataBorrow, Resources, R, W};
use peace_item_model::ItemId;

/// Defines the logic to instantiate and retrieve runtime data.
///
/// # Note for API Consumers
///
/// This trait is implemented by using the [`Data` derive].
///
/// [`Data` derive]: peace_data_derive::Data
pub trait Data<'borrow>: DataAccess + DataAccessDyn + Send {
    /// Borrows each of `Self`'s fields from the provided [`Resources`].
    ///
    /// This takes in the `item_id`, so that the type that implements this
    /// trait may further filter specific data within the borrowed data, scope
    /// to the item.
    ///
    /// # Parameters
    ///
    /// * `item_id`: ID of the item this borrow is used for.
    /// * `resources`: `Any` map to borrow the data from.
    fn borrow(item_id: &'borrow ItemId, resources: &'borrow Resources) -> Self;
}

impl<'borrow> Data<'borrow> for () {
    fn borrow(_item_id: &'borrow ItemId, _resources: &'borrow Resources) -> Self {}
}

impl<'borrow> Data<'borrow> for &'borrow () {
    fn borrow(_item_id: &'borrow ItemId, _resources: &'borrow Resources) -> Self {
        &()
    }
}

impl<'borrow, T> Data<'borrow> for R<'borrow, T>
where
    T: Debug + Send + Sync + 'static,
{
    fn borrow(_item_id: &'borrow ItemId, resources: &'borrow Resources) -> Self {
        <Self as DataBorrow>::borrow(resources)
    }
}

impl<'borrow, T> Data<'borrow> for W<'borrow, T>
where
    T: Debug + Send + Sync + 'static,
{
    fn borrow(_item_id: &'borrow ItemId, resources: &'borrow Resources) -> Self {
        <Self as DataBorrow>::borrow(resources)
    }
}