package transom

  1. Overview
  2. Docs
OCaml sidecar glue for Tauri-style desktop apps

Install

dune-project
 Dependency

Authors

Maintainers

Sources

v0.1.0.tar.gz
md5=a6aa17a9cab249e390f574553bc22620
sha512=56ac775c6b61fc45488795f2658fcfcbf380427f9477e94d6d69770a6df288851f266fb026d27696ba579caa37386404e4059fa2d2218b23e8b1e5c59cd9994b

doc/src/transom.runtime/protocol.ml.html

Source file protocol.ml

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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
type id = int

type call =
  { id : id
  ; method_ : string
  ; params : Yojson.Safe.t
  }

type cancel = { id : id }

type incoming =
  | Call of call
  | Cancel of cancel

type ok =
  { id : id
  ; result : Yojson.Safe.t
  }

type err =
  { id : id option
  ; error : Error.t
  }

type event =
  { id : id
  ; event : Yojson.Safe.t
  }

type outgoing =
  | Out_ok of ok
  | Out_err of err
  | Out_event of event

let assoc = function
  | `Assoc fields -> Ok fields
  | _ -> Error "frame must be an object"

let int_of_yojson name = function
  | `Int value -> Ok value
  | `Intlit value ->
    (try Ok (int_of_string value) with Failure _ -> Error (name ^ " must be an integer"))
  | _ -> Error (name ^ " must be an integer")

let id_of_yojson value = int_of_yojson "id" value

let id_opt_of_yojson = function
  | `Null -> Ok None
  | value ->
    (match id_of_yojson value with
     | Ok id -> Ok (Some id)
     | Error message -> Error message)

let string_of_yojson name = function
  | `String value -> Ok value
  | _ -> Error (name ^ " must be a string")

let field name fields =
  match List.assoc_opt name fields with
  | Some value -> Ok value
  | None -> Error ("missing field: " ^ name)

let optional_id json =
  match json with
  | `Assoc fields ->
    (match List.assoc_opt "id" fields with
     | None | Some `Null -> None
     | Some value -> Result.to_option (id_of_yojson value))
  | _ -> None

let incoming_to_yojson = function
  | Call { id; method_; params } ->
    `Assoc
      [ "kind", `String "call"
      ; "id", `Int id
      ; "method", `String method_
      ; "params", params
      ]
  | Cancel { id } ->
    `Assoc [ "kind", `String "cancel"; "id", `Int id ]

let incoming_of_yojson json =
  match assoc json with
  | Error message -> Error message
  | Ok fields ->
    (match field "kind" fields with
     | Error message -> Error message
     | Ok (`String "call") ->
       (match field "id" fields, field "method" fields, field "params" fields with
        | Ok id_json, Ok method_json, Ok params ->
          (match id_of_yojson id_json, string_of_yojson "method" method_json with
           | Ok id, Ok method_ -> Ok (Call { id; method_; params })
           | Error message, _ | _, Error message -> Error message)
        | Error message, _, _ | _, Error message, _ | _, _, Error message -> Error message)
     | Ok (`String "cancel") ->
       (match field "id" fields with
        | Error message -> Error message
        | Ok id_json ->
          (match id_of_yojson id_json with
           | Ok id -> Ok (Cancel { id })
           | Error message -> Error message))
     | Ok (`String kind) -> Error ("unknown incoming frame kind: " ^ kind)
     | Ok _ -> Error "kind must be a string")

let outgoing_to_yojson = function
  | Out_ok { id; result } ->
    `Assoc [ "kind", `String "ok"; "id", `Int id; "result", result ]
  | Out_err { id; error } ->
    `Assoc
      [ "kind", `String "err"
      ; "id", (match id with Some id -> `Int id | None -> `Null)
      ; "error", Error.to_yojson error
      ]
  | Out_event { id; event } ->
    `Assoc [ "kind", `String "event"; "id", `Int id; "event", event ]

let outgoing_of_yojson json =
  match assoc json with
  | Error message -> Error message
  | Ok fields ->
    (match field "kind" fields with
     | Error message -> Error message
     | Ok (`String "ok") ->
       (match field "id" fields, field "result" fields with
        | Ok id_json, Ok result ->
          (match id_of_yojson id_json with
           | Ok id -> Ok (Out_ok { id; result })
           | Error message -> Error message)
        | Error message, _ | _, Error message -> Error message)
     | Ok (`String "err") ->
       (match field "id" fields, field "error" fields with
        | Ok id_json, Ok error_json ->
          (match id_opt_of_yojson id_json, Error.of_yojson error_json with
           | Ok id, Ok error -> Ok (Out_err { id; error })
           | Error message, _ | _, Error message -> Error message)
        | Error message, _ | _, Error message -> Error message)
     | Ok (`String "event") ->
       (match field "id" fields, field "event" fields with
        | Ok id_json, Ok event ->
          (match id_of_yojson id_json with
           | Ok id -> Ok (Out_event { id; event })
           | Error message -> Error message)
        | Error message, _ | _, Error message -> Error message)
     | Ok (`String kind) -> Error ("unknown outgoing frame kind: " ^ kind)
     | Ok _ -> Error "kind must be a string")