package stdune

  1. Overview
  2. Docs
package stdune
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module StduneSource

  • alert unstable The API of this library is not stable and may change without notice.
Sourcemodule Appendable_list : sig ... end

Appendable lists: concatenation takes O(1) time, conversion to a list takes O(n).

Sourcemodule Nonempty_list : sig ... end

A (to be expanded) collection of functions for working with non-empty lists.

Sourcemodule Ansi_color : sig ... end
Sourcemodule Array : sig ... end
Sourcemodule Bytes : sig ... end
Sourcemodule Char : sig ... end
Sourcemodule Comparator : sig ... end
Sourcemodule Either : sig ... end

Left or right

Sourcemodule Exn : sig ... end

Exceptions

Sourcemodule Exn_with_backtrace : sig ... end

An exception together with the backtrace that raised it.

Sourcemodule Filename : sig ... end

Represent a path component.

Sourcemodule Hashtbl : sig ... end
Sourcemodule Table : sig ... end

Hashtable with a simple polymorphic type, but without the polymorphic equality.

Sourcemodule Int : sig ... end
Sourcemodule Id : sig ... end
Sourcemodule Io : sig ... end

IO operations.

Sourcemodule List : sig ... end
Sourcemodule Map : sig ... end
Sourcemodule Option : sig ... end

Optional values

Sourcemodule Or_exn : sig ... end

Either a value or an exception

Sourcemodule Ordering = Ordering
Sourcemodule Pp = Pp
Sourcemodule Result : sig ... end

Result type

Sourcemodule Set : sig ... end
Sourcemodule Signal : sig ... end

Unix Signal helpers

Sourcemodule Comparable : sig ... end
Sourcemodule Comparable_intf : sig ... end
Sourcemodule Staged : sig ... end
Sourcemodule String : sig ... end
Sourcemodule Bool : sig ... end
Sourcemodule Sexp : sig ... end

S-expressions

Sourcemodule Path : sig ... end

Representation of paths

Sourcemodule Fpath : sig ... end

Functions on paths that are represented as strings

Sourcemodule Univ_map : sig ... end

Universal maps

Sourcemodule Loc : sig ... end
Sourcemodule Env : sig ... end
Sourcemodule Env_path : sig ... end

Handle the PATH environment variable.

Sourcemodule Proc : sig ... end
Sourcemodule Type_eq : sig ... end

Equality between types. See Base.Type_equal for documentation.

Sourcemodule Nothing : sig ... end

Uninhabited type

Sourcemodule Bin : sig ... end

Binaries from the PATH

Sourcemodule Fdecl : sig ... end

Forward declarations

Sourcemodule Unit : sig ... end
Sourcemodule Monad : sig ... end

Monad signatures

Sourcemodule State : sig ... end

State monad transformer.

Sourcemodule Monoid : sig ... end
Sourcemodule Float : sig ... end
Sourcemodule Tuple : sig ... end
Sourcemodule Poly : sig ... end
Sourcemodule Code_error : sig ... end

A programming error that should be reported upstream

Sourcemodule User_error : sig ... end

Error meant for humans

Sourcemodule User_message : sig ... end

A message for the user

Sourcemodule User_warning : sig ... end

Non-fatal user errors

Sourcemodule Lexbuf : sig ... end

Lexing buffer utilities

Sourcemodule Scanf : sig ... end

Safe version of Scanf from the stdlib. Does not raise parsing errors errors.

Sourcemodule Sys : sig ... end
Sourcemodule Pid : sig ... end
Sourcemodule Applicative : sig ... end
Sourcemodule Top_closure_intf : sig ... end
Sourcemodule Top_closure : sig ... end
Sourcemodule Seq : sig ... end
Sourcemodule Temp : sig ... end

Temporary file management

Sourcemodule Queue : sig ... end
Sourcemodule Caller_id : sig ... end

Who called me?

Sourcemodule Dune_filesystem_stubs = Dune_filesystem_stubs
Sourcemodule Predicate : sig ... end

Predicates are functions of type 'a -> bool

Sourcemodule Bytes_unit : sig ... end
Sourcemodule Dev_null : sig ... end

Portable access /dev/null with some shared fd's to reduce the open fd count

Sourcemodule Platform : sig ... end

Platform detection.

Sourcemodule Unix_error : sig ... end
Sourcemodule File_kind : sig ... end
Sourcemodule type Applicative = sig ... end
Sourcemodule type Monad = sig ... end
Sourcemodule type Monoid = sig ... end
Sourceval reraise : exn -> _
Sourceval compare : 'a -> 'b -> [> `Use_Poly_compare ]
Sourcetype ('a, 'error) result = ('a, 'error) Result.t =
  1. | Ok of 'a
  2. | Error of 'error
Sourcetype ('a, 'b) either = ('a, 'b) Either.t =
  1. | Left of 'a
  2. | Right of 'b
Sourcetype ordering = Ordering.t =
  1. | Lt
  2. | Eq
  3. | Gt
Sourceval sprintf : ('a, unit, string) format -> 'a
Sourceval ksprintf : (string -> 'a) -> ('b, unit, string, 'a) format4 -> 'b
Sourceval printfn : ('a, unit, string, unit) format4 -> 'a
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