orengine-utils 3.1.0

This repository provides utilities for building high-performance applications.
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
83
84
85
86
87
88
89
90
91
92
93
94

//! This crate provides some useful utilities.
//!
//! - The [`hints module`](hints) provides hints to the compiler that affects how code
//!   should be emitted or optimized.
//! - The [`backoff module`](backoff) provides the [`Backoff`](backoff::Backoff) structure.
//! - The [`cache_padded module`](cache_padded) provides cache-padded atomics types and
//!   the [`CachePadded`] wrapper.
//! - The [`light_arc module`](light_arc) provides the [`LightArc`](light_arc::LightArc) type.
//! - The [`OrengineInstant`] that is a monotone clock that weights 8 bytes on Unix-like systems.
//! - The [`ArrayQueue`] that is an array-based queue implementation.
//! - The [`VecQueue`] that is a vector-based queue implementation.
//! - The [`numa module`](numa) provides sufficient utilities for working with NUMA nodes.
//! - The [`treap module`](treap) provides the [`Treap`](treap::Treap) — a randomized BST
//!   with subtree-augmented filtering for efficient filtered min/max queries.
//! - The [`cheap_random module`](cheap_random) provides fast non-cryptographic xorshift
//!   PRNGs for `u32` and `u64`, both stateful and thread-local.
//! - Configuration macros that are used to right compile the program based on the target platform
//!   such as [`config_target_pointer_width_64`], [`config_target_pointer_width_32`], and
//!   [`config_target_pointer_width_16`].

#![cfg_attr(feature = "no_std", no_std)]
#![deny(clippy::all)]
#![deny(clippy::assertions_on_result_states)]
#![deny(clippy::match_wild_err_arm)]
#![deny(clippy::allow_attributes_without_reason)]
#![warn(clippy::pedantic)]
#![warn(clippy::nursery)]
#![warn(clippy::cargo)]
#![allow(async_fn_in_trait, reason = "It improves readability.")]
#![allow(
    clippy::missing_const_for_fn,
    reason = "Since we cannot make a constant function non-constant after its release,
    we need to look for a reason to make it constant, and not vice versa."
)]
#![allow(clippy::inline_always, reason = "We write highly optimized code.")]
#![allow(
    clippy::must_use_candidate,
    reason = "It is better to developer think about it."
)]
#![allow(
    clippy::module_name_repetitions,
    reason = "This is acceptable most of the time."
)]
#![allow(
    clippy::missing_errors_doc,
    reason = "Unless the error is something special,
    the developer should document it."
)]
#![allow(clippy::redundant_pub_crate, reason = "It improves readability.")]
#![allow(clippy::struct_field_names, reason = "It improves readability.")]
#![allow(
    clippy::module_inception,
    reason = "It is fine if a file in has the same mane as a module."
)]
#![allow(clippy::if_not_else, reason = "It improves readability.")]
#![allow(
    rustdoc::private_intra_doc_links,
    reason = "It allows to create more readable docs."
)]
#![allow(
    clippy::negative_feature_names,
    reason = "It is needed to allow the `no_std` feature."
)]

extern crate alloc;
extern crate core;

mod array_buffer;
mod array_queue;
pub mod backoff;
pub mod cache_padded;
pub mod cheap_random;
mod clear_with;
mod config_macro;
pub mod hints;
#[cfg(not(feature = "no_std"))]
mod instant;
pub mod light_arc;
pub mod numa;
#[cfg(not(feature = "no_std"))]
pub mod rw_serde;
mod small_string;
pub mod treap;
#[cfg(not(feature = "no_std"))]
pub mod varint;
mod vec_queue;

pub use array_buffer::ArrayBuffer;
pub use array_queue::ArrayQueue;
pub use clear_with::*;
#[cfg(not(feature = "no_std"))]
pub use instant::OrengineInstant;
pub use small_string::*;
pub use vec_queue::VecQueue;