#[const_fn]

![crates-badge] ![docs-badge] ![license-badge] ![rustc-badge]

An attribute for easy generation of const functions with conditional compilations.

Usage

Add this to your Cargo.toml:

toml [dependencies] const_fn = "0.4"

The current const_fn requires Rust 1.31 or later.

Examples

```rust use constfn::constfn;

// function is const on specified version and later compiler (including beta and nightly)

[const_fn("1.36")]

pub const fn version() { /* ... */ }

// function is const on nightly compiler (including dev build)

[const_fn(nightly)]

pub const fn nightly() { /* ... */ }

// function is const if cfg(...) is true

[const_fn(cfg(...))]

pub const fn cfg() { /* ... */ }

// function is const if cfg(feature = "...") is true

[const_fn(feature = "...")]

pub const fn feature() { /* ... */ } ```

Alternatives

This crate is proc-macro, but is very lightweight, and has no dependencies.

You can manually define declarative macros with similar functionality (see if_rust_version), or you can define the same function twice with different cfg. (Note: the former approach requires more macros to be defined depending on the number of version requirements, the latter approach requires more functions to be maintained manually)

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

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.