package codept-lib

  1. Overview
  2. Docs
package codept-lib
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module ModnameSource

Module name.

the module name is a string that respects certain predicates. It is impossible to have any other characters than:

  • 'a' .. 'z'
  • 'A' .. 'Z'
  • '0' .. '9'
  • '_', '-' or '\''

NOTE: The dash is accepted even if it is normally prohibited. You can compile a module my-module.ml. However, the compiler issues a warning. In order to be the least restrictive, we accept this character.

The module name must start with a letter.

NOTE: The name of a module type can start with a non-capital letter:

  module type foo = sig end
Sourcetype t

The type of module names.

Sourceval of_string : string -> (t, [> `Msg of string ]) result

of_string str validates the given str as a module name or return an error with an explanation.

Sourceval normalize : string -> string

Capitalize string

Sourceval v : string -> t

v str calls of_string. It raises an Invalid_argument instead of returning an error.

Sourceval pp : t Pp.t

Pretty printer of t.

Sourceval to_string : t -> string

to_string t casts the given t as a string.

Sourceval compare : t -> t -> int
Sourceval reflect : t Pp.t
Sourcemodule Map : Support.Map.S with type key = t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct