mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-07 11:45:31 -05:00
0a167dc3dd
The goal is to use odig to build the documentation and with odig the comment of the function from the standard library are shown.
67 lines
1.5 KiB
OCaml
67 lines
1.5 KiB
OCaml
(* This file is free software, part of containers. See file "license" for more details. *)
|
|
|
|
(** Utils around char
|
|
|
|
@since 0.14 *)
|
|
|
|
include module type of struct
|
|
include Char
|
|
end
|
|
(** @inline *)
|
|
|
|
val compare : t -> t -> int
|
|
(** The comparison function for characters, with the same specification as
|
|
{!Stdlib.compare}. Along with the type [t], this function [compare]
|
|
allows the module [Char] to be passed as argument to the functors
|
|
{!Set.Make} and {!Map.Make}. *)
|
|
|
|
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
|