Skip to main content

mem_tools/
lib.rs

1#![ cfg_attr( feature = "no_std", no_std ) ]
2#![ doc( html_logo_url = "https://raw.githubusercontent.com/Wandalen/wTools/master/asset/img/logo_v3_trans_square.png" ) ]
3#![ doc(
4  html_favicon_url = "https://raw.githubusercontent.com/Wandalen/wTools/alpha/asset/img/logo_v3_trans_square_icon_small_v2.ico"
5) ]
6#![ doc( html_root_url = "https://docs.rs/mem_tools/latest/mem_tools/" ) ]
7
8//!
9//! Collection of tools to manipulate memory.
10//!
11
12#![ cfg_attr( doc, doc = include_str!( concat!( env!( "CARGO_MANIFEST_DIR" ), "/", "readme.md" ) ) ) ]
13#![ cfg_attr( not( doc ), doc = "Memory management utilities" ) ]
14
15/// Namespace with dependencies.
16#[ cfg( feature = "enabled" ) ]
17pub mod dependency
18{
19}
20
21/// Collection of general purpose meta tools.
22#[ cfg( feature = "enabled" ) ]
23pub mod mem;
24
25#[ doc( inline ) ]
26#[ allow( unused_imports ) ]
27#[ cfg( feature = "enabled" ) ]
28pub use own::*;
29
30/// Own namespace of the module.
31#[ cfg( feature = "enabled" ) ]
32#[ allow( unused_imports ) ]
33pub mod own
34{
35  use super::*;
36  #[ doc( inline ) ]
37  pub use orphan::*;
38  #[ doc( inline ) ]
39  pub use super::mem::orphan::*;
40}
41
42/// Orphan namespace of the module.
43#[ cfg( feature = "enabled" ) ]
44#[ allow( unused_imports ) ]
45pub mod orphan
46{
47  use super::*;
48  #[ doc( inline ) ]
49  pub use exposed::*;
50}
51
52/// Exposed namespace of the module.
53#[ cfg( feature = "enabled" ) ]
54#[ allow( unused_imports ) ]
55pub mod exposed
56{
57  use super::*;
58  #[ doc( inline ) ]
59  pub use prelude::*;
60  #[ doc( inline ) ]
61  pub use super::mem::exposed::*;
62}
63
64/// Prelude to use essentials: `use my_module::prelude::*`.
65#[ cfg( feature = "enabled" ) ]
66#[ allow( unused_imports ) ]
67pub mod prelude
68{
69  use super::*;
70  #[ doc( inline ) ]
71  pub use super::mem::prelude::*;
72}