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
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

/**
 * std/waitpoint — durable waitpoints for fan-in, fan-out, and long waits.
 *
 * Import with: `import "std/waitpoint"`.
 */
type WaitpointStatus = "open" | "completed" | "cancelled"

type Waitpoint = {
  id: string,
  status: WaitpointStatus,
  created_at: string,
  completed_at: string?,
  cancelled_at: string?,
  completed_by: string?,
  cancelled_by: string?,
  value: any?,
  reason: string?,
  metadata: any?,
}

type WaitpointWaitOptions = {timeout?: duration}

type WaitpointTerminalOptions = {by?: string, reason?: string, metadata?: any}

type WaitpointTimeoutError = {
  name: "WaitpointTimeoutError",
  category: "timeout",
  message: string,
  wait_id: string,
}

type WaitpointCancelledError = {
  name: "WaitpointCancelledError",
  category: "cancelled",
  message: string,
  wait_id: string,
  waitpoint_ids: list<string>,
  reason: string?,
}

/**
 * create.
 *
 * @effects: []
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: create(id_or_options)
 */
pub fn create(id_or_options = nil) {
  if id_or_options == nil {
    return __waitpoint_create()
  }
  return __waitpoint_create(id_or_options)
}

/**
 * wait.
 *
 * @effects: []
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: wait(waitpoints, options)
 */
pub fn wait(waitpoints, options = nil) {
  if options == nil {
    return __waitpoint_wait(waitpoints)
  }
  return __waitpoint_wait(waitpoints, options)
}

/**
 * complete.
 *
 * @effects: []
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: complete(waitpoint, value, options)
 */
pub fn complete(waitpoint, value, options = nil) {
  if options == nil {
    return __waitpoint_complete(waitpoint, value)
  }
  return __waitpoint_complete(waitpoint, value, options)
}

/**
 * cancel.
 *
 * @effects: []
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: cancel(waitpoint, options)
 */
pub fn cancel(waitpoint, options = nil) {
  if options == nil {
    return __waitpoint_cancel(waitpoint)
  }
  return __waitpoint_cancel(waitpoint, options)
}