Symtern：适用于所有用例的快速通用 interner

Symtern 是一系列用 Rust 编写的性能优异的 interner 实现。

Interners 通过将复杂数据映射到可简单比较的替身，然后可以恢复到原始值，通常在解析器、解析器生成器、语言解释器和编译器等软件中使用；它们可以在任何给定算法仅通过标识符比较输入时使用。

示例

正如我们所期望的，interning 与字符串类型配合得很好。

// Import Symtern's traits, which allow us to use each interner the same way
// regardless of the underlying implementation.
use symtern::prelude::*;

// Create a new pool that accepts `&str` arguments to `intern`, and uses
// `u8` as the backing representation for its symbol type.
let mut pool = symtern::Pool::<str,u8>::new();
if let (Ok(hello), Ok(world)) = (pool.intern("Hello"), pool.intern("World")) {
    assert!(hello != world);

    assert_eq!(hello, hello);
    assert_eq!(Ok(hello), pool.intern("Hello"));
    assert_eq!(Ok("Hello"), pool.resolve(hello));

    assert_eq!(world, world);
    assert_eq!(Ok(world), pool.intern("World"));
    assert_eq!(Ok("World"), pool.resolve(world));
}

错误处理

用于标识给定 interner 符号的类型只能表示有限范围内的值；因此，您必须允许尝试 intern 值可能失败的可能性。

use symtern::prelude::*;
use symtern::Pool;
use symtern::ErrorKind;

// Here we create a pool that uses `u8` as the backing representation for its
// symbol type, then proceed to completely fill it.
let mut pool = Pool::<u16,u8>::new();
for i in 0u16..256 {
    assert!(pool.intern(&i).is_ok(), "Failed to intern a value");
}
assert!(pool.is_full());

// Any attempt to intern a previously-interned input should still work...
assert!(pool.intern(&123).is_ok());
// ...but new values will elicit a `PoolOverflow` error:
match pool.intern(&1234) {
    Ok(sym) => panic!("Expected overflow, but got symbol {:?}", sym),
    Err(err) => match err.kind() {
        ErrorKind::PoolOverflow => (),
        _ => panic!("Wrong error kind returned from `intern`"),
    }
}

符号也可能无法解析；在这种情况下，错误的 .kind() 方法将返回 ErrorKind::NoSuchSymbol。

API 稳定性

此库的 API 尚未稳定；具体来说，需要考虑安全和复杂性的权衡。其中一些问题在 src/traits.rs 中进行了讨论。

贡献

发现一个错误？提交一个问题！有关于功能或改进的想法？我们非常乐意听取您的意见；fork 仓库并做出您的更改，然后提交拉取请求以供审查。

许可证

Symtern 可在 Apache License version 2.0 或 MIT License 下双许可。