package batteries

You can search for identifiers within the package.

in-package search v0.2.0

A community-maintained standard library extension

Install

Dune Dependency

github.com Readme Edit opam file Versions (14)

Authors

O

OCaml batteries-included team

Maintainers

Sources

v3.9.0.tar.gz

md5=ea26b5c72e6731e59d856626049cca4d

sha512=55975b62c26f6db77433a3ac31f97af609fc6789bb62ac38b267249c78fd44ff37fe81901f1cf560857b9493a6046dd37b0d1c0234c66bd59e52843aac3ce6cb

doc/batteries.unthreaded/BatReturn/index.html

Module `BatReturn`Source

Local exceptions/labels/goto/return.

This module defines a mechanism akin to SML's exception generators or to a generalization of C's return, i.e. the ability to define local labels, which may be used for immediately terminating an expression and returning a value. By opposition to usual OCaml exceptions, this mechanism

allows polymorphic return values
makes accidental exception catching slightly harder (while a local exception can escape its scope, it cannot be caught again by accident from this module).

Example:

  let find_in_array a e =
    label (fun label ->
      for i = 0 to Array.length a - 1 do
        if Array.get a i = e then return label (Some i)
      done;
      None)

author David Teller

@documents Return

Sourcetype 'a t

A label which may be used to return values of type 'a

Sourceval label : ('a t -> 'a) -> 'a

label f creates a new label x and invokes f x. If, during the execution of f, return x v is invoked, the execution of f x stops immediately and label f returns v. Otherwise, if f x terminates normally and returns y, label f returns y.

Calling return x v from outside scope f is a run-time error and causes termination of the program.

Sourceval with_label : ('a t -> 'a) -> 'a

as label

Sourceval return : 'a t -> 'a -> _

Return to a label. return l v returns to the point where label l was obtained and produces value l.

Calling return l v from outside the scope of l (i.e. the call to function label which produced l) is a run-time error and causes termination of the program.