package ocamlformat-lib

  1. Overview
  2. Docs
OCaml Code Formatter

Install

dune-project
 Dependency

Authors

Maintainers

Sources

ocamlformat-0.29.0.tbz
sha256=dac77f0a957ae782bb4b869b07b9803a872a34f8c1eae8901b42d21b623c9db5
sha512=b4ae6fda3c28e91dc12411b577df7b216e9b1afe5887bcb9e89c158e1313dc92183c29ffb256f47f5c9384af3ac8c505ec76849b26ae950b82c9b4c21a460819

doc/ocamlformat-lib.odoc_parser/Ocamlformat_odoc_parser/Compat/Char/index.html

Module Compat.CharSource

include module type of Char

Characters

Sourcetype t = char

An alias for the type of characters.

Sourceval code : char -> int

Return the integer code of the argument.

Sourceval chr : int -> char

Return the character with the given integer code.

Sourceval escaped : char -> string

Return a string representing the given character, with special characters escaped following the lexical conventions of OCaml. All characters outside the ASCII printable range [0x20;0x7E] are escaped, as well as backslash, double-quote, and single-quote.

Predicates and comparisons

See also the Ascii module.

Sourceval 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.

ASCII characters

Sourcemodule Ascii : sig ... end

ASCII character set support.

Sourceval lowercase_ascii : char -> char

Use the equivalent Ascii.lowercase instead.

  • since 4.03
Sourceval uppercase_ascii : char -> char

Use the equivalent Ascii.uppercase instead.

  • since 4.03

Hashing

Sourceval seeded_hash : int -> t -> int

A seeded hash function for characters, with the same output value as Hashtbl.seeded_hash. This function allows this module to be passed as argument to the functor Hashtbl.MakeSeeded.

  • since 5.1
Sourceval hash : t -> int

An unseeded hash function for characters, with the same output value as Hashtbl.hash. This function allows this module to be passed as argument to the functor Hashtbl.Make.

  • since 5.1
Sourceval equal : t -> t -> bool

The equal function for chars.

  • since 4.03.0