Skip to main content

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(nightly_doc_features, doc(cfg(feature = "metrics")))]
54#[cfg(feature = "metrics")]
55pub mod metrics;
56#[cfg_attr(nightly_doc_features, doc(cfg(feature = "network")))]
57#[cfg(feature = "network")]
58pub mod netio;
59pub mod now;
60pub mod num;
61pub mod option;
62#[cfg_attr(nightly_doc_features, doc(cfg(feature = "overflowing")))]
63#[cfg(feature = "overflowing")]
64pub mod overflowing;
65#[cfg_attr(nightly_doc_features, doc(cfg(all(feature = "pager", unix))))]
66#[cfg(all(feature = "pager", unix))]
67pub mod pager;
68#[cfg(not(target_family = "wasm"))]
69#[cfg(feature = "panic")]
70pub mod panic;
71pub mod path;
72pub mod permutations;
73#[cfg(feature = "process")]
74pub mod process;
75#[cfg(feature = "region")]
76pub mod region;
77#[cfg_attr(nightly_doc_features, doc(cfg(feature = "process")))]
78pub mod result;
79#[cfg_attr(nightly_doc_features, doc(cfg(feature = "async")))]
80#[cfg(feature = "async")]
81pub mod retry;
82pub mod secure;
83pub mod serde;
84#[cfg_attr(nightly_doc_features, doc(cfg(feature = "stack")))]
85#[cfg(feature = "stack")]
86pub mod stack;
87pub mod stats;
88pub mod str;
89#[cfg_attr(nightly_doc_features, doc(cfg(feature = "async")))]
90#[cfg(feature = "async")]
91pub mod task;
92#[cfg_attr(nightly_doc_features, doc(cfg(any(test, feature = "test"))))]
93#[cfg(any(test, feature = "test"))]
94pub mod test;
95pub mod thread;
96pub mod time;
97#[cfg_attr(nightly_doc_features, doc(cfg(feature = "tracing")))]
98#[cfg(feature = "tracing")]
99pub mod tracing;
100pub mod treat_as_equal;
101pub mod url;
102pub mod vec;
103
104pub use mz_ore_proc::{instrument, static_list, test};
105
106#[cfg_attr(nightly_doc_features, doc(cfg(feature = "overflowing")))]
107#[cfg(feature = "overflowing")]
108pub use overflowing::Overflowing;
109
110#[doc(hidden)]
111pub mod __private {
112    #[cfg(feature = "tracing")]
113    pub use tracing;
114}
115
116// Epoch: 1
117//
118// Bump this whenever we need to change the hash of a build without changing any code.