backtrace 0.2.3

A library to acquire a stack trace (backtrace) at runtime in a Rust program.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

[package]
name = "backtrace"
version = "0.2.3"
authors = ["Alex Crichton <alex@alexcrichton.com>",
           "The Rust Project Developers"]
license = "MIT/Apache-2.0"
readme = "README.md"
repository = "https://github.com/alexcrichton/backtrace-rs"
homepage = "https://github.com/alexcrichton/backtrace-rs"
documentation = "http://alexcrichton.com/backtrace-rs"
description = """
A library to acquire a stack trace (backtrace) at runtime in a Rust program.
"""
build = "build.rs"

[dependencies]
libc = "0.2"
backtrace-sys = { path = "backtrace-sys", version = "0.1.3", optional = true }
kernel32-sys = { version = "0.2", optional = true }
winapi = { version = "0.2.5", optional = true }
dbghelp-sys = { version = "0.2", optional = true }
cfg-if = "0.1"
rustc-demangle = "0.1"

# Optionally enable the ability to serialize a `Backtrace`
serde = { version = "0.7.10", optional = true }
rustc-serialize = { version = "0.3", optional = true }

[build-dependencies]
serde_codegen = { version = "0.7.10", optional = true }

# Each feature controls the two phases of finding a backtrace: getting a
# backtrace and then resolving instruction pointers to symbols. The default
# feature enables all the necessary features for each platform this library
# supports, but it can be disabled to have finer grained control over the
# dependencies.
#
# Note that not all features are available on all platforms, so even though a
# feature is enabled some other feature may be used instead.
[features]
default = ["libunwind", "libbacktrace", "dladdr", "dbghelp"]

    #=======================================
    # Methods of acquiring a backtrace
    #
    # - libunwind: when using this the libgcc library is linked against to get
    #   the unwinding support. This is generally the most reliable method to get
    #   a backtrace on unix.
    # - unix-backtrace: this uses the backtrace(3) function to acquire a
    #   backtrace, but is not as reliable as libunwind. It is, however,
    #   generally found in more locations.
    # - dbghelp: on windows this enables usage of dbghelp.dll to find a
    #   backtrace at runtime
    # - kernel32: on windows this enables using RtlCaptureStackBackTrace as the
    #   function to acquire a backtrace
    libunwind = []
    unix-backtrace = []
    dbghelp = ["kernel32-sys", "winapi", "dbghelp-sys"]
    kernel32 = []

    #=======================================
    # Methods of resolving symbols
    #
    # - libbacktrace: this feature activates the `backtrace-sys` dependency,
    #   building the libbacktrace library found in gcc repos. This library
    #   parses the DWARF info of ELF executables to find symbol names, and it
    #   can also provide filename/line number information if debuginfo is
    #   compiled in. This library currently only primarily works on unixes that
    #   are not OSX, however.
    # - dladdr: this feature uses the dladdr(3) function (a glibc extension) to
    #   resolve symbol names. This is fairly unreliable on linux, but works well
    #   enough on OSX.
    libbacktrace = ["backtrace-sys"]
    dladdr = []


    #=======================================
    # Methods of serialization
    #
    # Various features used for enabling rustc-serialize or syntex codegen.
    serialize-rustc = ["rustc-serialize"]
    serialize-serde = ["serde", "serde_codegen"]