xref: /linux/rust/kernel/prelude.rs (revision 182d95571ffa278f7c68a80d76de88a5333fb69f)
1 // SPDX-License-Identifier: GPL-2.0
2 
3 //! The `kernel` prelude.
4 //!
5 //! These are the most common items used by Rust code in the kernel,
6 //! intended to be imported by all Rust code, for convenience.
7 //!
8 //! # Examples
9 //!
10 //! ```
11 //! use kernel::prelude::*;
12 //! ```
13 
14 #[doc(no_inline)]
15 pub use core::{
16     mem::{align_of, align_of_val, size_of, size_of_val},
17     pin::Pin,
18 };
19 
20 pub use ::ffi::{
21     c_char, c_int, c_long, c_longlong, c_schar, c_short, c_uchar, c_uint, c_ulong, c_ulonglong,
22     c_ushort, c_void,
23 };
24 
25 pub use crate::alloc::{flags::*, Box, KBox, KVBox, KVVec, KVec, VBox, VVec, Vec};
26 
27 #[doc(no_inline)]
28 pub use macros::{export, kunit_tests, module, vtable};
29 
30 pub use pin_init::{init, pin_data, pin_init, pinned_drop, InPlaceWrite, Init, PinInit, Zeroable};
31 
32 pub use super::{build_assert, build_error};
33 
34 // `super::std_vendor` is hidden, which makes the macro inline for some reason.
35 #[doc(no_inline)]
36 pub use super::dbg;
37 pub use super::{dev_alert, dev_crit, dev_dbg, dev_emerg, dev_err, dev_info, dev_notice, dev_warn};
38 pub use super::{pr_alert, pr_crit, pr_debug, pr_emerg, pr_err, pr_info, pr_notice, pr_warn};
39 pub use core::format_args as fmt;
40 
41 pub use super::{try_init, try_pin_init};
42 
43 pub use super::static_assert;
44 
45 pub use super::error::{code::*, Error, Result};
46 
47 pub use super::{str::CStr, ThisModule};
48 
49 pub use super::init::InPlaceInit;
50 
51 pub use super::current;
52 
53 pub use super::uaccess::UserPtr;
54