harn-stdlib 0.8.26

Embedded Harn standard library source catalog
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

/**
 * std/monitors - wait for changing external state with poll-to-push optimization.
 *
 * Import with: `import "std/monitors"`.
 */
type MonitorWaitStatus = "matched" | "timed_out" | "interrupted"

type MonitorPollContext = {wait_id: string, poll_count: int, last_push_event: any}

type MonitorSource = {
  label?: string,
  poll: fn(MonitorPollContext) -> any,
  prefers_push?: bool,
  push_filter?: fn(any) -> bool,
}

type MonitorWaitOptions = {
  wait_id?: string,
  timeout: duration,
  poll_interval?: duration,
  source: MonitorSource,
  condition: fn(any) -> bool,
}

type MonitorWaitResult = {
  wait_id: string,
  status: MonitorWaitStatus,
  source_label: string?,
  started_at: string,
  resolved_at: string,
  state: any,
  condition_value: any,
  poll_count: int,
  push_wake_count: int,
  trace_id: string?,
  replay_of_event_id: string?,
  reason: string?,
}

/**
 * wait_for.
 *
 * @effects: []
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: wait_for(options)
 */
pub fn wait_for(options: MonitorWaitOptions) -> MonitorWaitResult {
  return monitor_wait_for_native(options)
}