cdk-common 0.16.0-rc.0

CDK common types and traits
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

//! Pubsub Event definition
//!
//! The Pubsub Event defines the Topic struct and how an event can be converted to Topics.

use std::hash::Hash;
use std::sync::Arc;

use serde::de::DeserializeOwned;
use serde::Serialize;

use super::Subscriber;

/// Pubsub settings
#[async_trait::async_trait]
pub trait Spec: Send + Sync {
    /// Topic
    type Topic: Send
        + Sync
        + Clone
        + Eq
        + PartialEq
        + Ord
        + PartialOrd
        + Hash
        + Send
        + Sync
        + DeserializeOwned
        + Serialize;

    /// Event
    type Event: Event<Topic = Self::Topic>
        + Send
        + Sync
        + Eq
        + PartialEq
        + DeserializeOwned
        + Serialize;

    /// Subscription Id
    type SubscriptionId: Clone
        + Default
        + Eq
        + PartialEq
        + Ord
        + PartialOrd
        + Hash
        + Send
        + Sync
        + DeserializeOwned
        + Serialize;

    /// Create a new context
    type Context;

    /// Create a new instance from a given context
    fn new_instance(context: Self::Context) -> Arc<Self>
    where
        Self: Sized;

    /// Callback function that is called on new subscriptions, to back-fill optionally the previous
    /// events
    async fn fetch_events(
        self: &Arc<Self>,
        topics: Vec<<Self::Event as Event>::Topic>,
        reply_to: Subscriber<Self>,
    ) where
        Self: Sized;
}

/// Event trait
pub trait Event: Clone + Send + Sync + Eq + PartialEq + DeserializeOwned + Serialize {
    /// Generic Topic
    ///
    /// It should be serializable/deserializable to be stored in the database layer and it should
    /// also be sorted in a BTree for in-memory matching
    type Topic;

    /// To topics
    fn get_topics(&self) -> Vec<Self::Topic>;
}