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

use crate::errors::SuffixError;

#[derive(Debug, Clone, Eq, PartialEq)]
pub struct SuffixItem<T> {
    /// Data received from Kafka Consumer
    pub item: SuffixItemType<T>,
    pub item_ver: u64,
    pub decision_ver: Option<u64>,
    /// Flag to denote if this item has been decided (is_decided is set to true irrespective of the outcome).
    pub is_decided: bool,
}

#[derive(Debug, Clone, Eq, PartialEq)]
pub struct SuffixConfig {
    /// Initial capacity of the suffix
    pub capacity: usize,
    /// - The suffix prune threshold from when we start checking if the suffix
    /// should prune.
    /// - Set to None if pruning is not required.
    /// - Defaults to None.
    pub prune_start_threshold: Option<usize>,
    /// Minimum size of suffix after prune.
    /// - Defaults to None.
    pub min_size_after_prune: Option<usize>,
}

impl Default for SuffixConfig {
    fn default() -> Self {
        const DEFAULT_CAPACITY: usize = 100_000;
        Self {
            capacity: DEFAULT_CAPACITY,
            prune_start_threshold: Default::default(),
            min_size_after_prune: Default::default(),
        }
    }
}

#[derive(Debug, Default, Clone)]
pub struct SuffixMeta {
    /// The version which is the head of the suffix
    pub head: u64,
    /// The last inserted version
    pub last_insert_vers: u64,
    /// The suffix index till where it's safe to prune.
    pub prune_index: Option<usize>,
    /// The suffix prune threshold from when we start checking if the suffix
    /// should prune.
    /// - If `None`, the suffix will not be pruned
    pub prune_start_threshold: Option<usize>,
    /// The minimum size to be maintained by the suffix.
    /// - If `None`, doesn't check for the minimum length to maintain in suffix while pruning.
    pub min_size_after_prune: Option<usize>,
}

pub type SuffixItemType<T> = T;

pub trait SuffixTrait<T> {
    fn get(&self, version: u64) -> SuffixResult<Option<SuffixItem<T>>>;
    fn get_mut(&mut self, version: u64) -> Option<&mut SuffixItem<T>>;
    fn get_meta(&self) -> &SuffixMeta;
    fn insert(&mut self, version: u64, message: SuffixItemType<T>) -> SuffixResult<()>;
    fn update_decision(&mut self, version: u64, decision_ver: u64) -> SuffixResult<()>;
    fn prune_till_index(&mut self, index: usize) -> SuffixResult<Vec<Option<SuffixItem<T>>>>;
    fn prune_till_version(&mut self, version: u64) -> SuffixResult<Vec<Option<SuffixItem<T>>>>;
    fn remove(&mut self, version: u64) -> SuffixResult<()>;
}

pub type SuffixResult<T> = Result<T, SuffixError>;