Files
linux/rust/kernel/prelude.rs
Gary Guo 43a393185e rust: prelude: add zerocopy{,_derive}::IntoBytes
In order to easily use `IntoBytes`, add it to the prelude.

This adds both the trait (`zerocopy::IntoBytes`) as well as the derive
macro (`zerocopy_derive::IntoBytes`).

[ This patch will simplify using the feature in several trees next cycle.

  Gary writes:

    This is wanted because I want to convert the upcoming I/O projection
    series to use `zerocopy` traits rather than keep using transmute
    module.

    It is most helpful for derives in doc tests; I do not want to
    explicitly use `#[derive(zerocopy_derive::IntoBytes)]` in the
    doc tests.

  For reference, the upcoming I/O projection series is at:

    https://lore.kernel.org/rust-for-linux/20260611-io_projection-v4-0-1f7224b02dcb@garyguo.net/

      - Miguel ]

Signed-off-by: Gary Guo <gary@garyguo.net>
Link: https://patch.msgid.link/20260611134802.2052296-1-gary@kernel.org
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
2026-06-17 00:32:42 +02:00

127 lines
1.9 KiB
Rust

// SPDX-License-Identifier: GPL-2.0
//! The `kernel` prelude.
//!
//! These are the most common items used by Rust code in the kernel,
//! intended to be imported by all Rust code, for convenience.
//!
//! # Examples
//!
//! ```
//! use kernel::prelude::*;
//! ```
#[doc(no_inline)]
pub use core::{
mem::{
align_of,
align_of_val,
size_of,
size_of_val, //
},
pin::Pin, //
};
#[doc(no_inline)]
pub use ::ffi::{
c_char,
c_int,
c_long,
c_longlong,
c_schar,
c_short,
c_uchar,
c_uint,
c_ulong,
c_ulonglong,
c_ushort,
c_void,
CStr, //
};
#[doc(no_inline)]
pub use macros::{
export,
fmt,
kunit_tests,
module,
vtable, //
};
#[doc(no_inline)]
pub use pin_init::{
init,
pin_data,
pin_init,
pinned_drop,
InPlaceWrite,
Init,
PinInit,
Zeroable, //
};
#[doc(no_inline)]
pub use zerocopy::{
FromBytes,
IntoBytes, //
};
#[doc(no_inline)]
pub use zerocopy_derive::{
FromBytes,
IntoBytes, //
};
#[doc(no_inline)]
pub use super::{
alloc::{
flags::*,
Box,
KBox,
KVBox,
KVVec,
KVec,
VBox,
VVec,
Vec, //
},
build_assert::{
build_assert,
build_error,
const_assert,
static_assert, //
},
current,
dev_alert,
dev_crit,
dev_dbg,
dev_emerg,
dev_err,
dev_info,
dev_notice,
dev_warn,
error::{
code::*,
Error,
Result, //
},
init::InPlaceInit,
pr_alert,
pr_crit,
pr_debug,
pr_emerg,
pr_err,
pr_info,
pr_notice,
pr_warn,
str::CStrExt as _,
try_init,
try_pin_init,
uaccess::UserPtr,
ThisModule, //
};
// `super::std_vendor` is hidden, which makes the macro inline for some reason.
#[doc(no_inline)]
pub use super::dbg;