https://github.com/sagebind/stability
Rust API stability attributes for the rest of us.
https://github.com/sagebind/stability
Last synced: 3 months ago
JSON representation
Rust API stability attributes for the rest of us.
- Host: GitHub
- URL: https://github.com/sagebind/stability
- Owner: sagebind
- License: mit
- Created: 2020-10-23T00:09:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-04T21:06:07.000Z (about 1 year ago)
- Last Synced: 2025-04-02T15:53:56.149Z (3 months ago)
- Language: Rust
- Size: 14.6 KB
- Stars: 29
- Watchers: 4
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Stability
Rust API stability attributes for the rest of us.
[](https://crates.io/crates/stability)
[][documentation]
[](LICENSE)

[](https://github.com/sagebind/stability/actions)## Overview
This crate provides attribute macros for specifying API stability of public API items of a crate. For a quick example:
```rust
/// This function does something really risky!
///
/// Don't use it yet!
#[stability::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:
```toml
[dependencies]
stability = "0.2.1"
```### 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](LICENSE) file for details.
[documentation]: https://docs.rs/stability