eventsourcingdb 2.0.4

A client library for the EventsourcingDB by the native web.
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//! This module contains supporting options for the client requests.

use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Options for reading events from the database
#[derive(Debug, Default, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ReadEventsOptions<'a> {
    /// Start reading events from this start event
    #[serde(skip_serializing_if = "Option::is_none")]
    pub from_latest_event: Option<ReadFromLatestEventOptions<'a>>,
    /// Lower bound of events to read
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lower_bound: Option<Bound<'a>>,
    /// Ordering of the returned events
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order: Option<Ordering>,
    /// Include recursive subject's events
    pub recursive: bool,
    /// Upper bound of events to read
    #[serde(skip_serializing_if = "Option::is_none")]
    pub upper_bound: Option<Bound<'a>>,
}

/// Options for observing events from the database
#[derive(Debug, Default, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ObserveEventsOptions<'a> {
    /// Start reading events from this start event
    #[serde(skip_serializing_if = "Option::is_none")]
    pub from_latest_event: Option<ObserveFromLatestEventOptions<'a>>,
    /// Lower bound of events to read
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lower_bound: Option<Bound<'a>>,
    /// Include recursive subject's events
    pub recursive: bool,
}

/// Ordering of the responses of requests
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum Ordering {
    /// Order the responses in chronological order
    Chronological,
    /// Order the responses in reverse chronological order
    Antichronological,
}

/// The type of the request bound
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum BoundType {
    /// The bound is included in the response
    Inclusive,
    /// The bound is excluded from the response
    Exclusive,
}

/// A single bound for the request
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Bound<'a> {
    /// The type of the bound
    #[serde(rename = "type")]
    pub bound_type: BoundType,
    /// The value of the bound
    pub id: &'a str,
}

/// The strategy for handling missing events while reading
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum ReadEventMissingStrategy {
    /// Read all events if the required one is missing
    ReadEverything,
    /// Read no events if the required one is missing
    ReadNothing,
}

/// The strategy for handling missing events while observing
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum ObserveEventMissingStrategy {
    /// Observe all events if the required one is missing
    ObserveEverything,
    /// Wait for the event until observing
    WaitForEvent,
}

/// Options for reading events from the latest event of certain type or subject
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ReadFromLatestEventOptions<'a> {
    /// The strategy for handling missing events
    pub if_event_is_missing: ReadEventMissingStrategy,
    /// The subject the event should be on
    pub subject: &'a str,
    /// The type of the event to read from
    #[serde(rename = "type")]
    pub ty: &'a str,
}

/// Options for observe events from the latest event of certain type or subject
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ObserveFromLatestEventOptions<'a> {
    /// The strategy for handling missing events
    pub if_event_is_missing: ObserveEventMissingStrategy,
    /// The subject the event should be on
    pub subject: &'a str,
    /// The type of the event to observe from
    #[serde(rename = "type")]
    pub ty: &'a str,
}

/// Represents an event type in the database
#[derive(Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
pub struct EventType {
    /// The name of the event type
    #[serde(rename = "eventType")]
    pub name: String,
    /// Whether the event type is a phantom type
    pub is_phantom: bool,
    /// The schema of the event type, if available
    pub schema: Option<Value>,
}