Mention "null pointer optimization" in option docs.

2021-05-29 09:54:31 -07:00 · 2021-05-29 09:54:31 -07:00 · 79575a1a8e
commit 79575a1a8e
parent 9f75dbfa69
1 changed files with 2 additions and 0 deletions
--- a/library/core/src/option.rs
+++ b/library/core/src/option.rs
@ -83,6 +83,8 @@
 //! * [`ptr::NonNull<U>`]
 //! * `#[repr(transparent)]` struct around one of the types in this list.
 //!
+//! This is called the "null pointer optimization" or NPO.
+//!
 //! It is further guaranteed that, for the cases above, one can
 //! [`mem::transmute`] from all valid values of `T` to `Option<T>` and
 //! from `Some::<T>(_)` to `T` (but transmuting `None::<T>` to `T`