File tree Expand file tree Collapse file tree 1 file changed +11
-2
lines changed Expand file tree Collapse file tree 1 file changed +11
-2
lines changed Original file line number Diff line number Diff line change 59
59
//! this library.
60
60
//!
61
61
//! For more details of UEFI itself, see the latest [UEFI Specification][spec].
62
- //!
63
- //! # Crate organisation
62
+ //!
63
+ //! # Library structure & Tips
64
64
//!
65
65
//! The top-level module contains some of the most used types and macros,
66
66
//! including the [`Handle`] and [`Result`] types, the [`CStr16`] and
67
67
//! [`CString16`] types for working with UCS-2 strings, and the [`entry`] and
68
68
//! [`guid`] macros.
69
69
//!
70
+ //! ## UEFI Strings
71
+ //!
72
+ //! Rust string literals are UTF-8 encoded and thus, not compatible with most
73
+ //! UEFI interfaces. We provide [`CStr16`] and [`CString16`] for proper working
74
+ //! with UCS-2 strings, including various transformation functions from standard
75
+ //! Rust strings. You can use [`ctr16!`] to create UCS-2 string literals at
76
+ //! compile time.
77
+ //!
70
78
//! ## Tables
71
79
//!
72
80
//! The [`SystemTable`] provides access to almost everything in UEFI. It comes
177
185
//! [`BootServices`]: table::boot::BootServices
178
186
//! [`GlobalAlloc`]: alloc::alloc::GlobalAlloc
179
187
//! [`SystemTable`]: table::SystemTable
188
+ //! [`ctr16!`]: crate::cstr16
180
189
//! [`unsafe_protocol`]: proto::unsafe_protocol
181
190
//! [contributing]: https://github.com/rust-osdev/uefi-rs/blob/main/CONTRIBUTING.md
182
191
//! [issue tracker]: https://github.com/rust-osdev/uefi-rs/issues
You can’t perform that action at this time.
0 commit comments