summaryrefslogtreecommitdiff
path: root/src/vycall_pbt.mli
diff options
context:
space:
mode:
authorJohn Estabrook <jestabro@vyos.io>2025-03-16 22:42:20 -0500
committerJohn Estabrook <jestabro@vyos.io>2025-03-16 23:13:39 -0500
commitfc5eaa7cd07b1f31c94e00d1bc4c2c368f61807d (patch)
treece79e37e5872adea36c2f7e5e8e9fd97fa4ee7ba /src/vycall_pbt.mli
parentd366f8e302ddadf9ad6ee74ca5430dcc52a7c67b (diff)
downloadvyconf-fc5eaa7cd07b1f31c94e00d1bc4c2c368f61807d.tar.gz
vyconf-fc5eaa7cd07b1f31c94e00d1bc4c2c368f61807d.zip
T7121: add commitd protobuf message definition file
Diffstat (limited to 'src/vycall_pbt.mli')
-rw-r--r--src/vycall_pbt.mli99
1 files changed, 99 insertions, 0 deletions
diff --git a/src/vycall_pbt.mli b/src/vycall_pbt.mli
new file mode 100644
index 0000000..5c8bd20
--- /dev/null
+++ b/src/vycall_pbt.mli
@@ -0,0 +1,99 @@
+
+(** Code for vycall.proto *)
+
+(* generated from "data/vycall.proto", do not edit *)
+
+
+
+(** {2 Types} *)
+
+type status = {
+ success : bool;
+ out : string;
+}
+
+type call = {
+ script_name : string;
+ tag_value : string option;
+ arg_value : string option;
+ reply : status option;
+}
+
+type commit = {
+ session_id : string;
+ named_active : string option;
+ named_proposed : string option;
+ dry_run : bool;
+ atomic : bool;
+ background : bool;
+ init : status option;
+ calls : call list;
+}
+
+
+(** {2 Basic values} *)
+
+val default_status :
+ ?success:bool ->
+ ?out:string ->
+ unit ->
+ status
+(** [default_status ()] is the default value for type [status] *)
+
+val default_call :
+ ?script_name:string ->
+ ?tag_value:string option ->
+ ?arg_value:string option ->
+ ?reply:status option ->
+ unit ->
+ call
+(** [default_call ()] is the default value for type [call] *)
+
+val default_commit :
+ ?session_id:string ->
+ ?named_active:string option ->
+ ?named_proposed:string option ->
+ ?dry_run:bool ->
+ ?atomic:bool ->
+ ?background:bool ->
+ ?init:status option ->
+ ?calls:call list ->
+ unit ->
+ commit
+(** [default_commit ()] is the default value for type [commit] *)
+
+
+(** {2 Formatters} *)
+
+val pp_status : Format.formatter -> status -> unit
+(** [pp_status v] formats v *)
+
+val pp_call : Format.formatter -> call -> unit
+(** [pp_call v] formats v *)
+
+val pp_commit : Format.formatter -> commit -> unit
+(** [pp_commit v] formats v *)
+
+
+(** {2 Protobuf Encoding} *)
+
+val encode_pb_status : status -> Pbrt.Encoder.t -> unit
+(** [encode_pb_status v encoder] encodes [v] with the given [encoder] *)
+
+val encode_pb_call : call -> Pbrt.Encoder.t -> unit
+(** [encode_pb_call v encoder] encodes [v] with the given [encoder] *)
+
+val encode_pb_commit : commit -> Pbrt.Encoder.t -> unit
+(** [encode_pb_commit v encoder] encodes [v] with the given [encoder] *)
+
+
+(** {2 Protobuf Decoding} *)
+
+val decode_pb_status : Pbrt.Decoder.t -> status
+(** [decode_pb_status decoder] decodes a [status] binary value from [decoder] *)
+
+val decode_pb_call : Pbrt.Decoder.t -> call
+(** [decode_pb_call decoder] decodes a [call] binary value from [decoder] *)
+
+val decode_pb_commit : Pbrt.Decoder.t -> commit
+(** [decode_pb_commit decoder] decodes a [commit] binary value from [decoder] *)