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 Edit opam file Versions (14)

Authors

O

OCaml batteries-included team

Maintainers

Sources

v3.6.0.tar.gz

md5=1bcb27dfbd130eb057561196ef851649

sha512=2a56611b09a5f1cba6457539f8b6bc87a5f2a5454b36cdb39f6e0d6a5dac6db179aab1ba87c74dd49cc41df31a9a96feb349028ea41df7371ecb47f4d9dfafc4

doc/batteries.unthreaded/BatPrintexc/Slot/index.html

Module `BatPrintexc.Slot`

type t = backtrace_slot

val is_raise : t -> bool

is_raise slot is true when slot refers to a raising point in the code, and false when it comes from a simple function call.

since 2.3.0 and OCaml 4.02

val is_inline : t -> bool

is_inline slot is true when slot refers to a call that got inlined by the compiler, and false when it comes from any other context.

since 4.04.0

val location : t -> location option

location slot returns the location information of the slot, if available, and None otherwise.

Some possible reasons for failing to return a location are as follow:

the slot corresponds to a compiler-inserted raise
the slot corresponds to a part of the program that has not been compiled with debug information (-g)

since 2.3.0 and OCaml 4.02

val name : t -> string option

name slot returns the name of the function or definition enclosing the location referred to by the slot.

name slot returns None if the name is unavailable, which may happen for the same reasons as location returning None.

since 4.11

val format : int -> t -> string option

format pos slot returns the string representation of slot as raw_backtrace_to_string would format it, assuming it is the pos-th element of the backtrace: the 0-th element is pretty-printed differently than the others.

Whole-backtrace printing functions also skip some uninformative slots; in that case, format pos slot returns None.

since 2.3.0 and OCaml 4.02