警告：quickphf 和 quickphf_codegen 当前使用标准库的 Hash 特性，该特性在不同的端序系统之间不可移植。

示例

目前，生成用于与 quickphf 一起使用的数据结构的唯一方法是运行 build_raw_map、build_map 或 build_set 之一，将结果作为字符串显示，然后将在所需位置导入生成的 Rust 代码。

例如，您可以编写一个 build.rs 脚本，例如

use std::env;
use std::fs::File;
use std::io::{BufWriter, Write};
use std::path::Path;

fn main() {
    let path = Path::new(&env::var("OUT_DIR").unwrap()).join("codegen.rs");
    let mut file = BufWriter::new(fs::File::create(&path).unwrap());

    let keys = ["jpg", "png", "svg"];
    let values = ["image/jpeg", "image/png", "image/svg+xml"];
    let code = quickphf_codegen::build_map(&keys, &values);

    write!(&mut file, code).unwrap();
}

然后通过以下方式在您的 lib.rs 中导入结果

static MIME_TYPES: quickphf::PhfMap<&'static str, &'static str> =
    include!(concat!(env!("OUT_DIR"), "/codegen.rs"));

高级用法

使用 QuickPHF 与自定义类型

要作为PhfMap或PhfSet的键，或在RawPhfMap或PhfMap中作为值，类型必须实现ConstInstantiable特质，该特质提供了一种在const上下文中实例化该类型任何值的方法。这个特质已经为许多内置类型实现了，但用户也可以通过两种方式之一为自己的自定义类型实现它：

1. 如果实例化类型值所需的代码与其Debug表示形式相同，例如，如下枚举

#[derive(Debug, Hash, PartialEq, Eq)]
enum PositionType {
    Contract { hours_per_week: u32 },
    Salaried,
    Managerial,
}

那么只需写出

impl quickphf_codegen::DebugInstantiable for PositionType {}

2. 用户必须提供一个自定义实现。例如，以下结构体具有私有字段，因此其值不能使用{}语法实例化，但它提供了一个new构造函数，该构造函数是const fn。因此，给定

#[derive(Debug, Hash, PartialEq, Eq)]
struct EmploymentRules {
    overtime_eligible: bool,
    bonus_eligible: bool,
}

impl EmploymentRules {
    pub const fn new(overtime_eligible: bool, bonus_eligible: bool) -> EmploymentRules {
        EmploymentRules {
            overtime_eligible,
            bonus_eligible,
        }
    }
}

我们可以通过以下方式提供一个自定义的ConstInstantiable实现：

use core::fmt;
use quickphf_codegen::*;

impl ConstInstantiable for EmploymentRules {
    fn fmt_const_new(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "EmploymentRules::new({}, {})",
            self.overtime_eligible, self.bonus_eligible
        )
    }
}

性能

使用quickphf_codegen生成基于PHF的数据结构比使用phf快约10倍。它可以在约300毫秒内生成1,000,000条条目的映射。

许可证

以下任何一种许可证下使用

• Apache License, Version 2.0, (LICENSE-APACHE或https://www.apache.org/licenses/LICENSE-2.0)
• MIT许可证 (LICENSE-MIT或https://opensource.org/licenses/MIT)
• zlib许可证 (LICENSE-ZLIB或https://opensource.org/license/zlib/)

由您选择。

贡献

除非您明确说明，否则您提交给作品包含在内的任何贡献，根据Apache-2.0许可证定义，将按照上述方式多许可证使用，没有任何额外的条款或条件。