mz_ore/
lib.rs

1// Copyright Materialize, Inc. and contributors. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License in the LICENSE file at the
6// root of this repository, or online at
7//
8//     http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16//! Internal utility libraries for Materialize.
17//!
18//! **ore** (_n_): the raw material from which more valuable materials are extracted.
19//! Modules are included in this crate when they are broadly useful but too
20//! small to warrant their own crate.
21
22#![warn(missing_docs, missing_debug_implementations)]
23#![cfg_attr(nightly_doc_features, feature(doc_cfg))]
24
25#[cfg_attr(nightly_doc_features, doc(cfg(feature = "assert-no-tracing")))]
26#[cfg(feature = "assert-no-tracing")]
27pub mod assert;
28pub mod bits;
29#[cfg_attr(nightly_doc_features, doc(cfg(feature = "bytes")))]
30#[cfg(feature = "bytes")]
31pub mod bytes;
32pub mod cast;
33#[cfg_attr(nightly_doc_features, doc(cfg(feature = "async")))]
34#[cfg(feature = "async")]
35pub mod channel;
36#[cfg_attr(nightly_doc_features, doc(cfg(feature = "cli")))]
37#[cfg(feature = "cli")]
38pub mod cli;
39pub mod collections;
40pub mod env;
41pub mod error;
42pub mod fmt;
43#[cfg_attr(nightly_doc_features, doc(cfg(feature = "async")))]
44#[cfg(feature = "async")]
45pub mod future;
46pub mod graph;
47pub mod hash;
48pub mod hint;
49#[cfg(feature = "id_gen")]
50pub mod id_gen;
51pub mod iter;
52pub mod lex;
53#[cfg_attr(
54    nightly_doc_features,
55    doc(cfg(all(feature = "bytes", feature = "region")))
56)]
57#[cfg(all(feature = "bytes", feature = "region", feature = "tracing"))]
58pub mod lgbytes;
59#[cfg_attr(nightly_doc_features, doc(cfg(feature = "metrics")))]
60#[cfg(feature = "metrics")]
61pub mod metrics;
62#[cfg_attr(nightly_doc_features, doc(cfg(feature = "network")))]
63#[cfg(feature = "network")]
64pub mod netio;
65pub mod now;
66pub mod num;
67pub mod option;
68#[cfg_attr(nightly_doc_features, doc(cfg(feature = "overflowing")))]
69#[cfg(feature = "overflowing")]
70pub mod overflowing;
71#[cfg(not(target_family = "wasm"))]
72#[cfg(feature = "panic")]
73pub mod panic;
74pub mod path;
75pub mod permutations;
76#[cfg(feature = "process")]
77pub mod process;
78#[cfg(feature = "region")]
79pub mod region;
80#[cfg_attr(nightly_doc_features, doc(cfg(feature = "process")))]
81pub mod result;
82#[cfg_attr(nightly_doc_features, doc(cfg(feature = "async")))]
83#[cfg(feature = "async")]
84pub mod retry;
85pub mod serde;
86#[cfg_attr(nightly_doc_features, doc(cfg(feature = "stack")))]
87#[cfg(feature = "stack")]
88pub mod stack;
89pub mod stats;
90pub mod str;
91#[cfg_attr(nightly_doc_features, doc(cfg(feature = "async")))]
92#[cfg(feature = "async")]
93pub mod task;
94#[cfg_attr(nightly_doc_features, doc(cfg(any(test, feature = "test"))))]
95#[cfg(any(test, feature = "test"))]
96pub mod test;
97pub mod thread;
98pub mod time;
99#[cfg_attr(nightly_doc_features, doc(cfg(feature = "tracing")))]
100#[cfg(feature = "tracing")]
101pub mod tracing;
102pub mod treat_as_equal;
103pub mod url;
104pub mod vec;
105
106pub use mz_ore_proc::{instrument, static_list, test};
107
108#[cfg_attr(nightly_doc_features, doc(cfg(feature = "overflowing")))]
109#[cfg(feature = "overflowing")]
110pub use overflowing::Overflowing;
111
112#[doc(hidden)]
113pub mod __private {
114    #[cfg(feature = "tracing")]
115    pub use tracing;
116}
117
118// Epoch: 1
119//
120// Bump this whenever we need to change the hash of a build without changing any code.