File tree 1 file changed +10
-1
lines changed
1 file changed +10
-1
lines changed Original file line number Diff line number Diff line change 82
82
//!
83
83
//! For more details of UEFI itself, see the latest [UEFI Specification][spec].
84
84
//!
85
- //! # Crate organisation
85
+ //! # Library Structure & Tips
86
86
//!
87
87
//! The top-level module contains some of the most used types and macros,
88
88
//! including the [`Handle`] and [`Result`] types, the [`CStr16`] and
89
89
//! [`CString16`] types for working with UCS-2 strings, and the [`entry`] and
90
90
//! [`guid`] macros.
91
91
//!
92
+ //! ## UEFI Strings
93
+ //!
94
+ //! Rust string literals are UTF-8 encoded and thus, not compatible with most
95
+ //! UEFI interfaces. We provide [`CStr16`] and [`CString16`] for proper working
96
+ //! with UCS-2 strings, including various transformation functions from standard
97
+ //! Rust strings. You can use [`ctr16!`] to create UCS-2 string literals at
98
+ //! compile time.
99
+ //!
92
100
//! ## Tables
93
101
//!
94
102
//! The [`SystemTable`] provides access to almost everything in UEFI. It comes
199
207
//! [`SystemTable`]: table::SystemTable
200
208
//! [`r-efi`]: https://crates.io/crates/r-efi
201
209
//! [`entry-macro`]: uefi_macros::entry
210
+ //! [`ctr16!`]: crate::cstr16
202
211
//! [`unsafe_protocol`]: proto::unsafe_protocol
203
212
//! [contributing]: https://github.com/rust-osdev/uefi-rs/blob/main/CONTRIBUTING.md
204
213
//! [issue tracker]: https://github.com/rust-osdev/uefi-rs/issues
You can’t perform that action at this time.
0 commit comments