限定在包含范围内的整数

Constrained 类型简单地表示为原始整数，但它们的值将始终包含在包含范围界限内。范围在编译时定义，通过为适当的 const 泛型参数赋值。限定类型提供可失败的建设和值赋值 API，它们还实现了范围边界的包装、饱和、溢出和检查算术操作。有关更多信息，请参阅所需类型的文档。

constrained_int 依赖于 const_guards 仓库来定义编译时约束，它本身使用不完整的 generic_const_exprs 功能。因此，此仓库只能使用 nightly 编译，更重要的是，必须将其视为仅限 实验性 的仓库。

默认情况下，此仓库为 no_std。有关更多信息，请参阅功能部分。

安装

# Cargo.toml

[dependencies]
constrained_int = "0.2"

示例

use constrained_int::i8::{ConstrainedI8, ConstrainedI8Error};

// Lower bound = -5, upper bound = 10, default = -1.
type Constrained = ConstrainedI8<-5, 10, -1>;
type ConstrainedError = ConstrainedI8Error<-5, 10>;

fn main() -> Result<(), ConstrainedError> {
    // Gets the default value.
    let mut constrained = Constrained::default();
    assert_eq!(constrained.get(), -1);

    // Sets within inclusive range, succeeds.
    constrained.set(-5)?;
    assert_eq!(constrained.get(), -5);

    // Below lower bound, fails.
    assert_eq!(constrained.checked_sub(1), None);
    assert_eq!(constrained.get(), -5);

    // Saturates at the upper bound.
    constrained = constrained.saturating_add(100);
    assert_eq!(constrained.get(), 10);

    // Sets out of boundary, fails.
    assert!(constrained.set(11).is_err());

    // Wraps around the upper bound.
    constrained = constrained.wrapping_add(1);
    assert_eq!(constrained.get(), -5);

    Ok(())
}

文档

此项目文档托管在 docs.rs。

安全性

此仓库使用 #![forbid)] 来确保所有内容都在 100% 安全的 Rust 中实现。