Skip to content

Commit 0ca315e

Browse files
authored
Chore: allow searching subcrates in vortex rustdoc (#5612)
Signed-off-by: Connor Tsui <[email protected]>
1 parent ac6073b commit 0ca315e

File tree

1 file changed

+113
-29
lines changed

1 file changed

+113
-29
lines changed

vortex/src/lib.rs

Lines changed: 113 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,83 @@
44
// https://github.com/rust-lang/cargo/pull/11645#issuecomment-1536905941
55
#![doc = include_str!(concat!("../", env!("CARGO_PKG_README")))]
66

7-
pub use vortex_array as array;
87
// vortex::compute is deprecated and will be ported over to expressions.
98
pub use vortex_array::compute;
109
// vortex::expr is in the process of having its dependencies inverted, and will eventually be
1110
// pulled back out into a vortex_expr crate.
1211
pub use vortex_array::expr;
1312
use vortex_array::expr::session::ExprSession;
1413
use vortex_array::session::ArraySession;
15-
pub use vortex_buffer as buffer;
16-
pub use vortex_dtype as dtype;
17-
pub use vortex_error as error;
18-
#[cfg(feature = "files")]
19-
pub use vortex_file as file;
20-
pub use vortex_flatbuffers as flatbuffers;
21-
pub use vortex_io as io;
2214
use vortex_io::session::RuntimeSession;
23-
pub use vortex_ipc as ipc;
24-
pub use vortex_layout as layout;
2515
use vortex_layout::session::LayoutSession;
26-
pub use vortex_mask as mask;
27-
pub use vortex_metrics as metrics;
2816
use vortex_metrics::VortexMetrics;
29-
pub use vortex_proto as proto;
30-
pub use vortex_scalar as scalar;
31-
pub use vortex_scan as scan;
32-
pub use vortex_session as session;
3317
use vortex_session::VortexSession;
34-
pub use vortex_utils as utils;
18+
19+
// We re-export like so in order to allow users to search inside subcrates when using the Rust docs.
20+
21+
pub mod array {
22+
pub use vortex_array::*;
23+
}
24+
25+
pub mod buffer {
26+
pub use vortex_buffer::*;
27+
}
28+
29+
pub mod dtype {
30+
pub use vortex_dtype::*;
31+
}
32+
pub mod error {
33+
pub use vortex_error::*;
34+
}
35+
36+
#[cfg(feature = "files")]
37+
pub mod file {
38+
pub use vortex_file::*;
39+
}
40+
41+
pub mod flatbuffers {
42+
pub use vortex_flatbuffers::*;
43+
}
44+
45+
pub mod io {
46+
pub use vortex_io::*;
47+
}
48+
49+
pub mod ipc {
50+
pub use vortex_ipc::*;
51+
}
52+
53+
pub mod layout {
54+
pub use vortex_layout::*;
55+
}
56+
57+
pub mod mask {
58+
pub use vortex_mask::*;
59+
}
60+
61+
pub mod metrics {
62+
pub use vortex_metrics::*;
63+
}
64+
65+
pub mod proto {
66+
pub use vortex_proto::*;
67+
}
68+
69+
pub mod scalar {
70+
pub use vortex_scalar::*;
71+
}
72+
73+
pub mod scan {
74+
pub use vortex_scan::*;
75+
}
76+
77+
pub mod session {
78+
pub use vortex_session::*;
79+
}
80+
81+
pub mod utils {
82+
pub use vortex_utils::*;
83+
}
3584

3685
pub mod compressor {
3786
pub use vortex_btrblocks::BtrBlocksCompressor;
@@ -40,19 +89,54 @@ pub mod compressor {
4089
}
4190

4291
pub mod encodings {
43-
pub use vortex_alp as alp;
44-
pub use vortex_bytebool as bytebool;
45-
pub use vortex_datetime_parts as datetime_parts;
46-
pub use vortex_decimal_byte_parts as decimal_byte_parts;
47-
pub use vortex_fastlanes as fastlanes;
48-
pub use vortex_fsst as fsst;
49-
pub use vortex_pco as pco;
50-
pub use vortex_runend as runend;
51-
pub use vortex_sequence as sequence;
52-
pub use vortex_sparse as sparse;
53-
pub use vortex_zigzag as zigzag;
92+
pub mod alp {
93+
pub use vortex_alp::*;
94+
}
95+
96+
pub mod bytebool {
97+
pub use vortex_bytebool::*;
98+
}
99+
100+
pub mod datetime_parts {
101+
pub use vortex_datetime_parts::*;
102+
}
103+
104+
pub mod decimal_byte_parts {
105+
pub use vortex_decimal_byte_parts::*;
106+
}
107+
108+
pub mod fastlanes {
109+
pub use vortex_fastlanes::*;
110+
}
111+
112+
pub mod fsst {
113+
pub use vortex_fsst::*;
114+
}
115+
116+
pub mod pco {
117+
pub use vortex_pco::*;
118+
}
119+
120+
pub mod runend {
121+
pub use vortex_runend::*;
122+
}
123+
124+
pub mod sequence {
125+
pub use vortex_sequence::*;
126+
}
127+
128+
pub mod sparse {
129+
pub use vortex_sparse::*;
130+
}
131+
132+
pub mod zigzag {
133+
pub use vortex_zigzag::*;
134+
}
135+
54136
#[cfg(feature = "zstd")]
55-
pub use vortex_zstd as zstd;
137+
pub mod zstd {
138+
pub use vortex_zstd::*;
139+
}
56140
}
57141

58142
/// Extension trait to create a default Vortex session.

0 commit comments

Comments
 (0)