yo_common/
lib.rs

1//! Shared vocabulary for the whole engine: addresses, ids, the error model,
2//! the two hash families, the geohash arithmetic and the cache hint the batch
3//! walk is built on.
4//!
5//! Everything here is used on the hot path, so the rules are strict. No
6//! allocation outside the error path, no dependencies, and every constant that
7//! another crate assumes is asserted in a test here rather than assumed twice.
8
9#![deny(missing_docs)]
10
11pub mod addr;
12pub mod blake3;
13pub mod crc;
14pub mod dtoa;
15pub mod eq;
16pub mod error;
17pub mod geo;
18pub mod glob;
19pub mod lock;
20pub mod num;
21pub mod prefetch;
22pub mod re;
23pub mod rng;
24pub mod small;
25pub(crate) mod sync;
26pub mod wyhash;
27pub mod xxh3;
28
29pub use addr::{ADDR_BITS, Addr, MAX_OFFSET, OFFSET_BITS, SPACE_BITS, ShardId, Space};
30pub use crc::{SLOT_COUNT, crc16, crc32c, hash_tag, slot_of};
31pub use eq::bytes_eq;
32pub use error::{Code, Error, Result};
33pub use glob::matches as glob_matches;
34pub use lock::{Held, Lock};
35pub use num::{
36    DIGITS_MAX, i64_digits, i64_len, parse_i64, push_double, push_i64, push_u64, u64_digits,
37};
38pub use prefetch::{prefetch, prefetch_read};
39pub use rng::Rng;
40pub use small::Small;
41pub use wyhash::{hash_key, tag_of, wyhash};
42pub use xxh3::hash64;
43
44/// The size of an index bucket, and the cache line the engine is built around.
45///
46/// Everything that claims to be one cache line asserts against this rather than
47/// writing 64 twice.
48pub const CACHE_LINE: usize = 64;
49
50/// The largest batch the shard loop drains in one pass (`04` section 3).
51///
52/// This is also the C ABI's `BATCH_MAX` and the size of every `_many` form, so
53/// it is here rather than in the shard crate.
54pub const BATCH_MAX: usize = 64;
yo_common/lib.rs

yo_common/
lib.rs
