lldb

This crate provides a safe binding to the public API for [LLDB], the debugger provided by the [LLVM project]. LLDB provides a modern, high performance debugger framework and is the default debugger for Mac OS X and iOS.

This builds upon a lower level crate lldb-sys.

Dual licensed under the MIT and Apache 2 licenses.

Documentation

The API is fully documented with examples: https://endoli.github.io/lldb.rs/

Installation

This crate works with Cargo and is on crates.io. Add it to your Cargo.toml like so:

[dependencies]
lldb = "0.0.5"

On Mac OS X, the LLDB.framework requires that an @rpath be configured for your application so that the LLDB.framework can be found. This isn't directly supported by Cargo today, but for local work and development, you can do this:

export DYLD_FRAMEWORK_PATH=/Applications/Xcode.app/Contents/SharedFrameworks

Development Guidelines

The official LLDB bindings for C++ and Python maintain very strict backwards compatibility. This has resulted in them having methods that are considered to be deprecated in favor of newer methods with more comprehensive arguments. The Rust bindings don't have that problem (yet), so we should try to only write bindings for the recommended usages and not the deprecated methods.

The documentation for the official bindings is also somewhat spotty. While it would be great to contribute upstream to improve that, we should seek to have these bindings be well documented and with more examples.

People should be jealous of the quality of our bindings. Sic itur ad astra.

Status of Implementation

Things are under active development. This project is not quite usable yet as some of the basic functionality is being written.

Support and Maintenance

I am developing this library largely on my own so far. I am able to offer support and maintenance, but would very much appreciate donations via Patreon. I can also provide commercial support, so feel free to contact me.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.