cordis-core 0.0.4

A typed, scope-based plugin runtime inspired by Cordis
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use std::{
    any::TypeId,
    marker::PhantomData,
    sync::{Arc, Weak},
};

use crate::{Result, runtime::Runtime};

#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub(crate) struct ServiceId {
    pub key: TypeId,
    pub isolation: u64,
}

impl ServiceId {
    pub fn root(key: TypeId) -> Self {
        Self { key, isolation: 0 }
    }
}

/// Typed service key. The associated value may be unsized, including a trait
/// object such as `dyn Database`.
pub trait ServiceKey: Send + Sync + 'static {
    type Value: ?Sized + Send + Sync + 'static;
    const NAME: &'static str;
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct ServiceDeclaration {
    pub(crate) key: TypeId,
    pub name: &'static str,
}

impl ServiceDeclaration {
    pub fn of<K: ServiceKey>() -> Self {
        Self {
            key: TypeId::of::<K>(),
            name: K::NAME,
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Dependency {
    pub(crate) key: TypeId,
    pub name: &'static str,
    pub required: bool,
}

impl Dependency {
    pub fn required<K: ServiceKey>() -> Self {
        Self {
            key: TypeId::of::<K>(),
            name: K::NAME,
            required: true,
        }
    }

    pub fn optional<K: ServiceKey>() -> Self {
        Self {
            key: TypeId::of::<K>(),
            name: K::NAME,
            required: false,
        }
    }
}

/// Non-owning service control handle. Dropping it does not unregister the
/// service; ownership remains with the activation scope.
pub struct ServiceHandle<K: ServiceKey> {
    pub(crate) runtime: Weak<Runtime>,
    pub(crate) id: ServiceId,
    pub(crate) owner: u64,
    pub(crate) token: u64,
    pub(crate) _key: PhantomData<fn() -> K>,
}

impl<K: ServiceKey> ServiceHandle<K> {
    pub fn replace(&self, value: Arc<K::Value>) -> Result<u64> {
        let runtime = self.runtime.upgrade().ok_or(crate::Error::PluginDisposed)?;
        runtime.replace_service::<K>(self.id, self.owner, self.token, value)
    }

    pub fn touch(&self) -> Result<u64> {
        let runtime = self.runtime.upgrade().ok_or(crate::Error::PluginDisposed)?;
        runtime.touch_service::<K>(self.id, self.owner, self.token)
    }

    /// Unregisters early. Safe to call repeatedly.
    pub fn remove(&self) -> bool {
        self.runtime
            .upgrade()
            .is_some_and(|runtime| runtime.remove_service(self.id, self.owner, self.token))
    }
}

pub(crate) struct ServiceEntry {
    pub value: Box<dyn std::any::Any + Send + Sync>,
    pub owner: u64,
    pub token: u64,
    pub generation: u64,
    pub name: &'static str,
    pub active: bool,
}

pub(crate) fn boxed_service<K: ServiceKey>(
    value: Arc<K::Value>,
) -> Box<dyn std::any::Any + Send + Sync> {
    Box::new(value)
}