fairjax_core 0.1.0

Core package for fairjax
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

pub mod any;
pub mod id;
pub mod mailbox;
pub mod mapping;
pub mod strategies {
    pub mod brute_force;
    pub mod partitions;
    pub mod stateful_tree;
}

pub mod matching {
    pub mod case_match;
    pub mod matched_ids;
    pub mod matched_messages;
}

pub use any::{AnyKey, AnyKeyBox};
pub use id::{CaseId, MessageId, MessageIdFactory};
pub use mailbox::MailBox;
pub use mapping::Mapping;

pub use matching::case_match::CaseMatch;
pub use matching::matched_ids::{MatchedIds, MatchedIdsSorted};
pub use matching::matched_messages::MatchedMessages;

/// A store for received unmatched messages of type M identified by a unique MessageId
pub type Store<M> = std::collections::HashMap<MessageId, M>;

/// Guard function, for a case with C messages of type M in its pattern.
pub type GuardFn<const C: usize, M> = fn(&[&M; C], &Mapping<C>) -> bool;

/// Accept function that returns true when a message can be consumed by a case pattern
pub type AcceptFn<M> = fn(&M) -> bool;

/// Key function that extracts a composite key (based on uniting variable) from a message
pub type KeyFn<M> = fn(&M) -> Option<AnyKeyBox>;

/// Top interface for interacting with a case on messages of type M.
/// K is the maximum pattern size across all cases.
pub trait CaseHandler<M> {
    fn consume(&mut self, id: MessageId, store: &Store<M>) -> Option<MatchedIds>;
    fn remove(&mut self, messages: &MatchedIds, store: &Store<M>);
    fn is_empty(&self) -> bool;
}

#[cfg(test)]
#[macro_export]
macro_rules! id {
    ($id:expr) => {
        $crate::MessageId::new($id)
    };
}