Source file err.ml

(*****************************************************************************)
(*                                                                           *)
(*  Copyright (C) 2026 Yves Ndiaye                                           *)
(*                                                                           *)
(* This Source Code Form is subject to the terms of the Mozilla Public       *)
(* License, v. 2.0. If a copy of the MPL was not distributed with this       *)
(* file, You can obtain one at https://mozilla.org/MPL/2.0/.                 *)
(*                                                                           *)
(*****************************************************************************)

(** Operations on errors while parsing a configuration file. *)

(** The type of errors appearing while parsing a configuration file. *)
type t =
  | ParsingError of string
  | MissingSection of string
  | MissingKey of string

(** [parsing_error msg] creates a [ParsingError] error with [msg]. *)
let parsing_error s = ParsingError s

(** [missing_section msg] creates a [MissingSection] error with [msg]. *)
let missing_section s = MissingSection s

(** [missing_key msg] create a [MissingKey] error with [msg] *)
let missing_key s = MissingKey s

(** [to_string error] returns the string representation of [error]; *)
let to_string = function
  | ParsingError s ->
      Printf.sprintf "parsing error : %s" s
  | MissingSection missing ->
      Printf.sprintf "missing section : %s" missing
  | MissingKey key ->
      Printf.sprintf "key error : %s" key