rustc_data_structures/
lib.rs

1//! Various data structures used by the Rust compiler. The intention
2//! is that code in here should not be *specific* to rustc, so that
3//! it can be easily unit tested and so forth.
4//!
5//! # Note
6//!
7//! This API is completely unstable and subject to change.
8
9// tidy-alphabetical-start
10#![allow(internal_features)]
11#![allow(rustc::default_hash_types)]
12#![allow(rustc::potential_query_instability)]
13#![deny(unsafe_op_in_unsafe_fn)]
14#![feature(allocator_api)]
15#![feature(ascii_char)]
16#![feature(ascii_char_variants)]
17#![feature(assert_matches)]
18#![feature(auto_traits)]
19#![feature(cfg_select)]
20#![feature(const_default)]
21#![feature(const_trait_impl)]
22#![feature(core_intrinsics)]
23#![feature(dropck_eyepatch)]
24#![feature(extend_one)]
25#![feature(file_buffered)]
26#![feature(map_try_insert)]
27#![feature(min_specialization)]
28#![feature(negative_impls)]
29#![feature(never_type)]
30#![feature(ptr_alignment_type)]
31#![feature(rustc_attrs)]
32#![feature(sized_hierarchy)]
33#![feature(test)]
34#![feature(thread_id_value)]
35#![feature(trusted_len)]
36#![feature(type_alias_impl_trait)]
37#![feature(unwrap_infallible)]
38// tidy-alphabetical-end
39
40// Temporarily re-export `assert_matches!`, so that the rest of the compiler doesn't
41// have to worry about it being moved to a different module in std during stabilization.
42// FIXME(#151359): Remove this when `feature(assert_matches)` is stable in stage0.
43// (This doesn't necessarily need to be fixed during the beta bump itself.)
44#[cfg(bootstrap)]
45pub use std::assert_matches::{assert_matches, debug_assert_matches};
46use std::fmt;
47#[cfg(not(bootstrap))]
48pub use std::{assert_matches, debug_assert_matches};
49
50pub use atomic_ref::AtomicRef;
51pub use ena::{snapshot_vec, undo_log, unify};
52// Re-export `hashbrown::hash_table`, because it's part of our API
53// (via `ShardedHashMap`), and because it lets other compiler crates use the
54// lower-level `HashTable` API without a tricky `hashbrown` dependency.
55pub use hashbrown::hash_table;
56pub use rustc_index::static_assert_size;
57// Re-export some data-structure crates which are part of our public API.
58pub use {either, indexmap, smallvec, thin_vec};
59
60pub mod aligned;
61pub mod base_n;
62pub mod binary_search_util;
63pub mod fingerprint;
64pub mod flat_map_in_place;
65pub mod flock;
66pub mod frozen;
67pub mod fx;
68pub mod graph;
69pub mod intern;
70pub mod jobserver;
71pub mod marker;
72pub mod memmap;
73pub mod obligation_forest;
74pub mod owned_slice;
75pub mod packed;
76pub mod profiling;
77pub mod sharded;
78pub mod small_c_str;
79pub mod snapshot_map;
80pub mod sorted_map;
81pub mod sso;
82pub mod stable_hasher;
83pub mod stack;
84pub mod steal;
85pub mod svh;
86pub mod sync;
87pub mod tagged_ptr;
88pub mod temp_dir;
89pub mod thinvec;
90pub mod thousands;
91pub mod transitive_relation;
92pub mod unhash;
93pub mod union_find;
94pub mod unord;
95pub mod vec_cache;
96pub mod work_queue;
97
98mod atomic_ref;
99
100/// This calls the passed function while ensuring it won't be inlined into the caller.
101#[inline(never)]
102#[cold]
103pub fn outline<F: FnOnce() -> R, R>(f: F) -> R {
104    f()
105}
106
107/// Returns a structure that calls `f` when dropped.
108pub fn defer<F: FnOnce()>(f: F) -> OnDrop<F> {
109    OnDrop(Some(f))
110}
111
112pub struct OnDrop<F: FnOnce()>(Option<F>);
113
114impl<F: FnOnce()> OnDrop<F> {
115    /// Disables on-drop call.
116    #[inline]
117    pub fn disable(mut self) {
118        self.0.take();
119    }
120}
121
122impl<F: FnOnce()> Drop for OnDrop<F> {
123    #[inline]
124    fn drop(&mut self) {
125        if let Some(f) = self.0.take() {
126            f();
127        }
128    }
129}
130
131/// This is a marker for a fatal compiler error used with `resume_unwind`.
132pub struct FatalErrorMarker;
133
134/// Turns a closure that takes an `&mut Formatter` into something that can be display-formatted.
135pub fn make_display(f: impl Fn(&mut fmt::Formatter<'_>) -> fmt::Result) -> impl fmt::Display {
136    struct Printer<F> {
137        f: F,
138    }
139    impl<F> fmt::Display for Printer<F>
140    where
141        F: Fn(&mut fmt::Formatter<'_>) -> fmt::Result,
142    {
143        fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
144            (self.f)(fmt)
145        }
146    }
147
148    Printer { f }
149}
150
151// See comment in compiler/rustc_middle/src/tests.rs and issue #27438.
152#[doc(hidden)]
153pub fn __noop_fix_for_windows_dllimport_issue() {}
154
155#[macro_export]
156macro_rules! external_bitflags_debug {
157    ($Name:ident) => {
158        impl ::std::fmt::Debug for $Name {
159            fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
160                ::bitflags::parser::to_writer(self, f)
161            }
162        }
163    };
164}
rustc_data_structures/lib.rs

rustc_data_structures/
lib.rs
