package shakuhachi

  1. Overview
  2. Docs
A music collection manager

Install

dune-project
 Dependency

Authors

Maintainers

Sources

0.1.0.tar.gz
sha256=bb7f91cc44c09f922d2a614e9e01fd0d2976840bacf839a8b99de63c6fc5b3b8
sha512=f02827db4228b017bb2ad7d64cb1c0667831ec2341e6f759266ec834e40627c2affeace143c6d5e769b3acce63f889b3cbd1a9ca4768091840e8fce1d4750f86

doc/src/shakuhachi.config/err.ml.html

Source file err.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
(**********************************************************************************************)
(*                                                                                            *)
(* This file is part of shakuhachi: a music collection manager                                *)
(* Copyright (C) 2025 Yves Ndiaye                                                             *)
(*                                                                                            *)
(* shakuhachi is free software: you can redistribute it and/or modify it under the terms      *)
(* of the GNU General Public License as published by the Free Software Foundation,            *)
(* either version 3 of the License, or (at your option) any later version.                    *)
(*                                                                                            *)
(* shakuhachi is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;    *)
(* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR           *)
(* PURPOSE.  See the GNU General Public License for more details.                             *)
(* You should have received a copy of the GNU General Public License along with shakuhachi.   *)
(* If not, see <http://www.gnu.org/licenses/>.                                                *)
(*                                                                                            *)
(**********************************************************************************************)

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