安装

要安装和使用bnum，只需将以下行添加到您的Cargo.toml文件中的[dependencies]部分

bnum = "0.11.0"

或者，为了启用bnum的各种功能，例如，添加以下行代替

bnum = { version = "0.11.0", features = ["rand"] } # enables the "rand" feature

示例用法

注意：文档中的示例使用特定的类型别名（例如U256、U512或I256、I512）来给出大多数方法的正确使用示例。这些类型并没有什么特殊之处：所有使用这些类型展示的方法都为任何值N的所有无符号/有符号bnum整数实现了。

// As of version 0.6.0, you can parse integers from string slices at compile time with the const methods `from_str_radix` or `parse_str_radix`:
use bnum::types::{U256, I256};
use bnum::errors::ParseIntError;

// `parse_str_radix` returns an integer, and panics if the string fails to parse
const UINT_FROM_DECIMAL_STR: U256 = U256::parse_str_radix("12345678901234567890", 10);

// If you are not sure that the string will successfully parse, you can use `from_str_radix` which returns a `Result`
const RESULT_INT_FROM_HEXA_STR: Result<I256, ParseIntError> = I256::from_str_radix("-1234567890abcdef", 16);

assert_eq!(format!("{}", UINT_FROM_DECIMAL_STR), "12345678901234567890");
assert_eq!(format!("{:x}", RESULT_INT_FROM_HEXA_STR.unwrap().abs()), "1234567890abcdef");

// Calculate the `n`th Fibonacci number, using the type alias `U512`.

use bnum::types::U512; // `U512` is a type alias for a `BUint` which contains 8 `u64` digits

// Calculate the nth Fibonacci number
fn fibonacci(n: usize) -> U512 {
    let mut f_n: U512 = U512::ZERO; // or `U512::from(0u8)`
    let mut f_n_next: U512 = U512::ONE; // or `U512::from(1u8)`

    for _ in 0..n {
        let temp = f_n_next;
        f_n_next += f_n;
        f_n = temp;
    }

    f_n
}

let n = 100;
let f_n = fibonacci(n);

println!("The {}th Fibonacci number is {}", n, f_n);
// Prints "The 100th Fibonacci number is 354224848179261915075"

assert_eq!(f_n, U512::from_str_radix("354224848179261915075", 10).unwrap());

// Construct an 80-bit signed integer
// Out of [64, 32, 16, 8], 16 is the largest divisor of 80, so use `BIntD16`
use bnum::BIntD16;

type I80 = BIntD16<5>; // 80 / 16 = 5

let neg_one = I80::NEG_ONE; // -1
assert_eq!(neg_one.count_ones(), 80); // signed integers are stored in two's complement so `-1` is represented as `111111...`

功能

模糊测试

arbitrary功能从arbitrary存储库中推导出Arbitrary特质。**注意：目前，此功能无法与no_std一起使用（请参阅https://github.com/rust-fuzz/arbitrary/issues/38）**。

随机数生成

rand功能允许通过rand存储库创建随机bnum整数。

序列化和反序列化

serde功能通过serde和serde_big_array存储库启用bnum整数的序列化和反序列化。

num_traits和num_integer特质实现

numtraits功能包括来自num_traits和num_integer存储库的特质的实现，例如AsPrimitive、Signed、Integer和Roots。

Quickcheck

quickcheck功能启用quickcheck存储库中的Arbitrary特质。**注意：目前，此功能无法与no_std一起使用**。

Zeroize

zeroize功能启用zeroize存储库中的Zeroize特质。

Valuable

valuable功能启用valuable存储库中的Valuable特质。

夜间功能

激活 nightly 功能将启用 from_be_bytes、from_le_bytes、from_ne_bytes、to_be_bytes、to_le_bytes 和 to_ne_bytes 方法，这些方法作用于 bnum 的无符号和有符号整数，并将 unchecked_... 方法标记为 const。但这样做代价是只能编译在 nightly 版本上。这个功能使用的 nightly 特性包括：generic_const_exprs、const_trait_impl 和 const_option_ext。

测试

此软件包使用 quickcheck 软件包以及特定的边缘情况进行测试。将方法输出与原始整数的等效方法输出进行比较，以确保行为相同。

最低支持的 Rust 版本

当前最低支持的 Rust 版本 (MSRV) 为 1.65.0。

文档

如果一个方法没有明确文档，它将链接到原始 Rust 整数上定义的等效方法（因为它们具有相同的功能）。

注意：bnum 目前处于预 1.0.0 阶段。根据 语义版本控制指南，在此阶段，公共 API 可能包含破坏性更改。然而，由于 API 设计尽可能类似于 Rust 原始整数的 API，因此不太可能出现大量的破坏性更改。

已知问题

目前，对于 bnum 整数实现了 From 特性，从所有 Rust 原始整数。然而，这种行为并不完全正确。例如，如果创建了一个 24 位宽的无符号整数（BUintD8<3>），则不应实现 From<u32> 等，而应实现 TryFrom<u32>。为确保正确的行为，可以使用来自 num_traits 软件包的 FromPrimitive 特性，因为这总会返回一个 Option 而不是整数本身。