Instability

Rust API stability attributes for the rest of us.

Overview

This is a fork of the Stability crate with the blessing of the original maintainer Stephen M. Coakley (@sagebind). This crate provides attribute macros for specifying API stability of public API items of a crate. For a quick example:

/// This function does something really risky!
///
/// Don't use it yet!
#[instability::unstable(feature = "risky-function")]
pub fn risky_function() {
    unimplemented!()
}

Please check out the documentation for detailed usage.

Installation

Install via Cargo by adding to your Cargo.toml file:

[dependencies]
instability = "0.3"

Supported Rust versions

The current release is only guaranteed to work with the latest stable Rust compiler.

License

This project's source code and documentation are licensed under the MIT license. See the LICENSE file for details.