summaryrefslogtreecommitdiff
path: root/src/reference_tree.mli
diff options
context:
space:
mode:
authorJohn Estabrook <jestabro@vyos.io>2025-10-27 22:42:37 -0500
committerJohn Estabrook <jestabro@vyos.io>2025-11-03 08:11:05 -0600
commit2aea7ddbc092b03dbf07dce385786b9c5c16a881 (patch)
tree3c837d8e16cb52d1d7bb85ea4afc5ffb913a81d0 /src/reference_tree.mli
parent6ced0e36b3f98675d82007f8c77193e2836c4b60 (diff)
downloadvyos1x-config-2aea7ddbc092b03dbf07dce385786b9c5c16a881.tar.gz
vyos1x-config-2aea7ddbc092b03dbf07dce385786b9c5c16a881.zip
T7915: add compiler alerts and annotations
Diffstat (limited to 'src/reference_tree.mli')
-rw-r--r--src/reference_tree.mli37
1 files changed, 35 insertions, 2 deletions
diff --git a/src/reference_tree.mli b/src/reference_tree.mli
index 1a72ad9..42d9021 100644
--- a/src/reference_tree.mli
+++ b/src/reference_tree.mli
@@ -50,45 +50,78 @@ val default_data : ref_node_data
val default : t
val load_from_xml : t -> string -> t
+[@@alert exn "Reference_tree.Bad_interface_definition"]
val find_xml_child : string -> Xml_light_types.xml -> Xml_light_types.xml option
val validate_path : string -> t -> string list -> unit
+[@@alert exn "Reference_tree.Validation_error"]
val validate_tree_filter : string -> t -> Config_tree.t -> Config_tree.t * string
val validate_tree : string -> t -> Config_tree.t -> string
+[@@alert exn "Reference_tree.Validation_error"]
val split_path : t -> string list -> string list * string option
val is_multi : t -> string list -> bool
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val is_hidden : t -> string list -> bool
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val is_secret : t -> string list -> bool
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val is_tag : t -> string list -> bool
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val is_leaf : t -> string list -> bool
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val is_valueless : t -> string list -> bool
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val get_owner : t -> string list -> string option
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val get_priority : t -> string list -> string option
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val get_help_string : t -> string list -> string
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val get_value_help : t -> string list -> (string * string) list
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val get_completion_data : t -> string list -> (node_type * bool * string) list
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val refpath : t -> string list -> string list
-
-val get_ceil_data : (ref_node_data -> string option) -> t -> string list -> string option
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val set_tag_data : t -> Config_tree.t -> string list -> Config_tree.t
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val set_leaf_data : t -> Config_tree.t -> string list -> Config_tree.t
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
+
+val get_ceil_data : (ref_node_data -> string option) -> t -> string list -> string option
+[@@alert exn "Vytree.Empty_path"]
+[@@alert exn "Vytree.Nonexistent_path"]
val render_json : t -> string