yo-common 0.3.20

Ids, the generated error model, wyhash and the CRC family for yo.
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

//! Shared vocabulary for the whole engine: addresses, ids, the error model,
//! the two hash families, and the cache hint the batch walk is built on.
//!
//! Everything here is used on the hot path, so the rules are strict. No
//! allocation outside the error path, no dependencies, and every constant that
//! another crate assumes is asserted in a test here rather than assumed twice.

#![deny(missing_docs)]

pub mod addr;
pub mod blake3;
pub mod crc;
pub mod dtoa;
pub mod eq;
pub mod error;
pub mod glob;
pub mod lock;
pub mod num;
pub mod prefetch;
pub mod re;
pub mod rng;
pub mod small;
pub(crate) mod sync;
pub mod wyhash;
pub mod xxh3;

pub use addr::{ADDR_BITS, Addr, MAX_OFFSET, OFFSET_BITS, SPACE_BITS, ShardId, Space};
pub use crc::{SLOT_COUNT, crc16, crc32c, hash_tag, slot_of};
pub use eq::bytes_eq;
pub use error::{Code, Error, Result};
pub use glob::matches as glob_matches;
pub use lock::{Held, Lock};
pub use num::{
    DIGITS_MAX, i64_digits, i64_len, parse_i64, push_double, push_i64, push_u64, u64_digits,
};
pub use prefetch::{prefetch, prefetch_read};
pub use rng::Rng;
pub use small::Small;
pub use wyhash::{hash_key, tag_of, wyhash};
pub use xxh3::hash64;

/// The size of an index bucket, and the cache line the engine is built around.
///
/// Everything that claims to be one cache line asserts against this rather than
/// writing 64 twice.
pub const CACHE_LINE: usize = 64;

/// The largest batch the shard loop drains in one pass (`04` section 3).
///
/// This is also the C ABI's `BATCH_MAX` and the size of every `_many` form, so
/// it is here rather than in the shard crate.
pub const BATCH_MAX: usize = 64;