]> git.proxmox.com Git - rustc.git/blob - vendor/error-chain/README.md
New upstream version 1.45.0+dfsg1
[rustc.git] / vendor / error-chain / README.md
1 # error-chain - Consistent error handling for Rust
2
3 [![Build Status](https://api.travis-ci.org/rust-lang-nursery/error-chain.svg?branch=master)](https://travis-ci.org/rust-lang-nursery/error-chain)
4 [![Latest Version](https://img.shields.io/crates/v/error-chain.svg)](https://crates.io/crates/error-chain)
5 [![License](https://img.shields.io/github/license/rust-lang-nursery/error-chain.svg)](https://github.com/rust-lang-nursery/error-chain)
6
7 `error-chain` makes it easy to take full advantage of Rust's error
8 handling features without the overhead of maintaining boilerplate
9 error types and conversions. It implements an opinionated strategy for
10 defining your own error types, as well as conversions from others'
11 error types.
12
13 [Documentation (crates.io)](https://docs.rs/error-chain).
14
15 [Documentation (master)](https://rust-lang-nursery.github.io/error-chain).
16
17 ## Quick start
18
19 If you just want to set up your new project with error-chain,
20 follow the [quickstart.rs] template, and read this [intro]
21 to error-chain.
22
23 [quickstart.rs]: https://github.com/rust-lang-nursery/error-chain/blob/master/examples/quickstart.rs
24 [intro]: http://brson.github.io/2016/11/30/starting-with-error-chain
25
26 ## Supported Rust version
27
28 Please view the beginning of the [Travis configuration file](.travis.yml)
29 to see the oldest supported Rust version.
30
31 Note that `error-chain` supports older versions of Rust when built with
32 `default-features = false`.
33
34 ## License
35
36 MIT/Apache-2.0