evident 0.12.2

Pub/Sub library using IDs to identify events.
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

//! Contains the [`EventEntry] trait.
//!
//! [req:event.entry]

use std::hash::Hash;

use super::{origin::Origin, Id, Msg};

/// Trait that must be implemented for a custom *evident* event-entry.\
/// This implementation must then be used for implementations of the traits [`EventEntry`] and [`IntermediaryEvent`](super::intermediary::IntermediaryEvent).\
/// All implementations are needed to create an *evident* publisher using the [`create_static_publisher!()`](crate::create_static_publisher) macro.
///
/// The optional [`Filter`](super::filter::Filter) trait must also use the same implementation of this [`Id`] trait.
///
/// **Note:** Since it is a trait, the custom implementation may contain additional fields and functions.
///
/// [req:event.entry], [req:event.entry.generic]
pub trait EventEntry<K: Id, M: Msg>: Default + Clone + Hash + Send + Sync + 'static {
    /// Creates a new [`EventEntry`].
    ///
    /// **Note:** This function should be called inside the implementation for [`IntermediaryEvent::new`](super::intermediary::IntermediaryEvent::new).
    ///
    /// # Arguments
    ///
    /// * `event_id` ... The ID of the event that was set to create this entry
    /// * `msg` ... Optional main event message
    /// * `origin` ... The [`Origin`] the event was set at
    ///
    /// [req:event.entry], [req:event.id], [req:event.msg], [req:event.origin]
    fn new(event_id: K, msg: Option<impl Into<M>>, origin: Origin) -> Self;

    /// Returns the [`Id`] of this event.
    ///
    /// [req:event.id]
    fn get_event_id(&self) -> &K;

    /// Convert this [`EventEntry`] into the [`Id`] of this event.
    ///
    /// [req:event.id]
    fn into_event_id(self) -> K;

    /// Get the entry-ID that was generated when the event was set.
    ///
    /// [req:event.entry.id]
    fn get_entry_id(&self) -> crate::uuid::Uuid;

    /// Get the main message that was given when the event was set,
    /// or `None` if no message was given.
    ///
    /// [req:event.msg]
    fn get_msg(&self) -> Option<&M>;

    /// Get the [`Origin`] the event was set at.
    ///
    /// [req:event.origin]
    fn get_origin(&self) -> &Origin;
}