limon-core 0.3.3

limon core library
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

/// Configuration type for a monitor.
#[derive(Debug)]
pub enum Config {
  /// Ping monitor configuration.
  Ping(PingConfig),

  /// HTTP monitor configuration.
  Http(HttpConfig),
}

/// Configuration for a Ping monitor.
#[derive(Debug, Default, serde::Deserialize)]
pub struct PingConfig {
  /// How often the monitor should perform a check, in seconds.
  pub check_frequency: i64,

  /// Number of consecutive successful checks required to confirm a state change.
  pub confirmation_period: i64,

  /// Number of consecutive failed checks required to consider the monitor recovered.
  pub recovery_period: i64,

  /// Maximum time, in seconds, to wait for a ping response before timing out.
  pub timeout: i64,
}

/// Configuration for an `HTTP` monitor.
#[derive(Debug, Default, serde::Deserialize)]
pub struct HttpConfig {
  /// How often the monitor should perform a check, in seconds.
  pub check_frequency: i64,

  /// Number of consecutive successful checks required to confirm a state change.
  pub confirmation_period: i64,

  /// Number of consecutive failed checks required to consider the monitor recovered.
  pub recovery_period: i64,

  /// Maximum time, in seconds, to wait for an `HTTP` response before timing out.
  pub timeout: i32,

  /// HTTP method to use (e.g., `GET`, `POST`).
  pub method: String,

  /// Protocol to use (`HTTP` or `HTTPS`).
  pub protocol: String,

  /// Optional port number. If `None`, defaults to 80 for `HTTP` and 443 for `HTTPS`.
  pub port: Option<u16>,

  /// Optional request path (e.g., "/health").
  pub path: Option<String>,

  /// Optional request body for methods like `POST` or `PUT`.
  pub body: Option<String>,

  /// Optional keyword to search for in the response body.
  pub keyword: Option<String>,

  /// Expected `HTTP` status code.
  pub expected_status_code: i32,

  /// Whether to follow `HTTP` redirects.
  pub follow_redirects: bool,

  /// Whether to keep cookies when following redirects.
  pub keep_cookies_on_redirects: bool,

  /// Optional `HTTP` headers to include in the request.
  pub headers: Option<Vec<Header>>,
}

/// Represents a single `HTTP` header (name-value pair).
#[derive(Debug, serde::Deserialize)]
pub struct Header {
  /// The name of the `HTTP` header (e.g., `"Content-Type"`).
  pub name: String,

  /// The value of the `HTTP` header (e.g., `"application/json"`).
  pub value: String,
}