fnv64-rs 0.3.5

A lightweight, zero-dependency implementation of the FNV (Fowler–Noll–Vo) hash function.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

#![cfg(feature = "std")]
#![cfg_attr(docsrs, doc(cfg(feature = "std")))]
//! 📦 Standard Collection Aliases
//!
//! This module provides type aliases for [`HashMap`] and [`HashSet`] using various FNV hashing variants.
//!
//! **Note: All types in this module are re-exported at the crate root.** You can use them
//! via `fnv64_rs::*` instead of `fnv64_rs::collection::*`.

use crate::{Fnv0BuildHasher, Fnv1BuildHasher, Fnv1aBuildHasher, FnvBuildHasher};
use std::collections::{HashMap, HashSet};

#[cfg(feature = "nightly")]
use std::alloc::{Allocator, Global};

// --- HashMap Aliases ---

#[cfg(not(feature = "nightly"))]
/// A [`HashMap`] using the **FNV-0** algorithm.
pub type Fnv0HashMap<K, V> = HashMap<K, V, Fnv0BuildHasher>;
#[cfg(feature = "nightly")]
#[cfg_attr(docsrs, doc(cfg(feature = "nightly")))]
/// A [`HashMap`] using the **FNV-0** algorithm with support for custom allocators.
pub type Fnv0HashMap<K, V, A = Global> = HashMap<K, V, Fnv0BuildHasher, A>;

#[cfg(not(feature = "nightly"))]
/// A [`HashMap`] using the **FNV-1** algorithm.
pub type Fnv1HashMap<K, V> = HashMap<K, V, Fnv1BuildHasher>;
#[cfg(feature = "nightly")]
#[cfg_attr(docsrs, doc(cfg(feature = "nightly")))]
/// A [`HashMap`] using the **FNV-1** algorithm with support for custom allocators.
pub type Fnv1HashMap<K, V, A = Global> = HashMap<K, V, Fnv1BuildHasher, A>;

#[cfg(not(feature = "nightly"))]
/// A [`HashMap`] using the **FNV-1a** algorithm.
pub type Fnv1aHashMap<K, V> = HashMap<K, V, Fnv1aBuildHasher>;
#[cfg(feature = "nightly")]
#[cfg_attr(docsrs, doc(cfg(feature = "nightly")))]
/// A [`HashMap`] using the **FNV-1a** algorithm with support for custom allocators.
pub type Fnv1aHashMap<K, V, A = Global> = HashMap<K, V, Fnv1aBuildHasher, A>;

#[cfg(not(feature = "nightly"))]
/// A [`HashMap`] using the **default** FNV implementation (aliases **FNV-1a**).
pub type FnvHashMap<K, V> = HashMap<K, V, FnvBuildHasher>;
#[cfg(feature = "nightly")]
#[cfg_attr(docsrs, doc(cfg(feature = "nightly")))]
/// A [`HashMap`] using the **default** FNV implementation with support for custom allocators.
pub type FnvHashMap<K, V, A = Global> = HashMap<K, V, FnvBuildHasher, A>;

// --- HashSet Aliases ---

#[cfg(not(feature = "nightly"))]
/// A [`HashSet`] using the **FNV-0** algorithm.
pub type Fnv0HashSet<V> = HashSet<V, Fnv0BuildHasher>;
#[cfg(feature = "nightly")]
#[cfg_attr(docsrs, doc(cfg(feature = "nightly")))]
/// A [`HashSet`] using the **FNV-0** algorithm with support for custom allocators.
pub type Fnv0HashSet<V, A = Global> = HashSet<V, Fnv0BuildHasher, A>;

#[cfg(not(feature = "nightly"))]
/// A [`HashSet`] using the **FNV-1** algorithm.
pub type Fnv1HashSet<V> = HashSet<V, Fnv1BuildHasher>;
#[cfg(feature = "nightly")]
#[cfg_attr(docsrs, doc(cfg(feature = "nightly")))]
/// A [`HashSet`] using the **FNV-1** algorithm with support for custom allocators.
pub type Fnv1HashSet<V, A = Global> = HashSet<V, Fnv1BuildHasher, A>;

#[cfg(not(feature = "nightly"))]
/// A [`HashSet`] using the **FNV-1a** algorithm.
pub type Fnv1aHashSet<V> = HashSet<V, Fnv1aBuildHasher>;
#[cfg(feature = "nightly")]
#[cfg_attr(docsrs, doc(cfg(feature = "nightly")))]
/// A [`HashSet`] using the **FNV-1a** algorithm with support for custom allocators.
pub type Fnv1aHashSet<V, A = Global> = HashSet<V, Fnv1aBuildHasher, A>;

#[cfg(not(feature = "nightly"))]
/// A [`HashSet`] using the **default** FNV implementation (aliases **FNV-1a**).
pub type FnvHashSet<V> = HashSet<V, FnvBuildHasher>;
#[cfg(feature = "nightly")]
#[cfg_attr(docsrs, doc(cfg(feature = "nightly")))]
/// A [`HashSet`] using the **default** FNV implementation with support for custom allocators.
pub type FnvHashSet<V, A = Global> = HashSet<V, FnvBuildHasher, A>;