ocaml-containers/src/core/CCChar.mli
2024-12-25 14:56:14 +01:00

61 lines
1.2 KiB
OCaml

(* This file is free software, part of containers. See file "license" for more details. *)
(** Utils around char
@since 0.14 *)
(** @inline *)
include module type of struct
include Char
end
val of_int_exn : int -> t
(** Alias to {!Char.chr}.
Return the character with the given ASCII code.
@raise Invalid_argument if the int is not within [0 … 255].
@since 1.0 *)
val of_int : int -> t option
(** Safe version of {!of_int_exn}.
@since 1.0 *)
val to_int : t -> int
(** Alias to {!Char.code}.
Return the ASCII code of the argument.
@since 1.0 *)
val to_string : t -> string
(** [to_string c] returns a string containing [c]
@since 2.7 *)
val pp_buf : Buffer.t -> t -> unit
(** Renamed from [pp] since 2.0. *)
val pp : Format.formatter -> t -> unit
(** Renamed from [print] since 2.0. *)
(** {2 Infix Operators}
@since 3.3 *)
module Infix : sig
val ( = ) : t -> t -> bool
(** @since 3.3 *)
val ( <> ) : t -> t -> bool
(** @since 3.3 *)
val ( < ) : t -> t -> bool
(** @since 3.3 *)
val ( > ) : t -> t -> bool
(** @since 3.3 *)
val ( <= ) : t -> t -> bool
(** @since 3.3 *)
val ( >= ) : t -> t -> bool
(** @since 3.3 *)
end
include module type of Infix