/usr/lib/ocaml/obus/oBus_string.mli is in libobus-ocaml-dev 1.1.5-5build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | (*
* oBus_string.mli
* ---------------
* Copyright : (c) 2008, Jeremie Dimino <jeremie@dimino.org>
* Licence : BSD3
*
* This file is a part of obus, an ocaml implementation of D-Bus.
*)
(** Restriction on strings used with D-Bus *)
(** There are a lot a various restrictions for strings used in D-Bus.
Obus only verify strings when a message is sent or received *)
type error = {
(** Contains informations about invalid strings *)
typ : string;
(** Type of string ("string", "bus name", "error name", "path",
...) *)
str : string;
(** The string which fail to validate *)
ofs : int;
(** is the position in byte where the validation failed *)
msg : string;
(** explain why the string failed to validate *)
}
val error_message : error -> string
(** [error_message error] returns a human-readabe error message *)
(** {8 Error projections} *)
val typ : error -> string
val str : error -> string
val ofs : error -> int
val msg : error -> string
(** {6 Validators} *)
type validator = string -> error option
(** Function which test if a string is correct.
- if it is, returns [None]
- if not, returns [Some(ofs, msg)] *)
exception Invalid_string of error
val assert_validate : validator -> string -> unit
(** Raises {!Invalid_string} if the given string failed to
validate *)
(** {6 Common strings} *)
type t = string
(** Type for common strings, restrictions are:
- a string must be encoded in valid UTF-8
- a string must not contains the null byte *)
val validate : validator
(** Validatition function for commong strings *)
|