3 //! Type [`Option`] represents an optional value: every [`Option`]
4 //! is either [`Some`] and contains a value, or [`None`], and
5 //! does not. [`Option`] types are very common in Rust code, as
6 //! they have a number of uses:
9 //! * Return values for functions that are not defined
10 //! over their entire input range (partial functions)
11 //! * Return value for otherwise reporting simple errors, where [`None`] is
13 //! * Optional struct fields
14 //! * Struct fields that can be loaned or "taken"
15 //! * Optional function arguments
16 //! * Nullable pointers
17 //! * Swapping things out of difficult situations
19 //! [`Option`]s are commonly paired with pattern matching to query the presence
20 //! of a value and take action, always accounting for the [`None`] case.
23 //! fn divide(numerator: f64, denominator: f64) -> Option<f64> {
24 //! if denominator == 0.0 {
27 //! Some(numerator / denominator)
31 //! // The return value of the function is an option
32 //! let result = divide(2.0, 3.0);
34 //! // Pattern match to retrieve the value
36 //! // The division was valid
37 //! Some(x) => println!("Result: {x}"),
38 //! // The division was invalid
39 //! None => println!("Cannot divide by 0"),
44 // FIXME: Show how `Option` is used in practice, with lots of methods
46 //! # Options and pointers ("nullable" pointers)
48 //! Rust's pointer types must always point to a valid location; there are
49 //! no "null" references. Instead, Rust has *optional* pointers, like
50 //! the optional owned box, <code>[Option]<[Box\<T>]></code>.
52 //! [Box\<T>]: ../../std/boxed/struct.Box.html
54 //! The following example uses [`Option`] to create an optional box of
55 //! [`i32`]. Notice that in order to use the inner [`i32`] value, the
56 //! `check_optional` function first needs to use pattern matching to
57 //! determine whether the box has a value (i.e., it is [`Some(...)`][`Some`]) or
61 //! let optional = None;
62 //! check_optional(optional);
64 //! let optional = Some(Box::new(9000));
65 //! check_optional(optional);
67 //! fn check_optional(optional: Option<Box<i32>>) {
69 //! Some(p) => println!("has value {p}"),
70 //! None => println!("has no value"),
77 //! Rust guarantees to optimize the following types `T` such that
78 //! [`Option<T>`] has the same size as `T`:
83 //! * `fn`, `extern "C" fn`[^extern_fn]
84 //! * [`num::NonZero*`]
85 //! * [`ptr::NonNull<U>`]
86 //! * `#[repr(transparent)]` struct around one of the types in this list.
88 //! [^extern_fn]: this remains true for any other ABI: `extern "abi" fn` (_e.g._, `extern "system" fn`)
90 //! [`Box<U>`]: ../../std/boxed/struct.Box.html
91 //! [`num::NonZero*`]: crate::num
92 //! [`ptr::NonNull<U>`]: crate::ptr::NonNull
94 //! This is called the "null pointer optimization" or NPO.
96 //! It is further guaranteed that, for the cases above, one can
97 //! [`mem::transmute`] from all valid values of `T` to `Option<T>` and
98 //! from `Some::<T>(_)` to `T` (but transmuting `None::<T>` to `T`
99 //! is undefined behaviour).
101 //! # Method overview
103 //! In addition to working with pattern matching, [`Option`] provides a wide
104 //! variety of different methods.
106 //! ## Querying the variant
108 //! The [`is_some`] and [`is_none`] methods return [`true`] if the [`Option`]
109 //! is [`Some`] or [`None`], respectively.
111 //! [`is_none`]: Option::is_none
112 //! [`is_some`]: Option::is_some
114 //! ## Adapters for working with references
116 //! * [`as_ref`] converts from <code>[&][][Option]\<T></code> to <code>[Option]<[&]T></code>
117 //! * [`as_mut`] converts from <code>[&mut] [Option]\<T></code> to <code>[Option]<[&mut] T></code>
118 //! * [`as_deref`] converts from <code>[&][][Option]\<T></code> to
119 //! <code>[Option]<[&]T::[Target]></code>
120 //! * [`as_deref_mut`] converts from <code>[&mut] [Option]\<T></code> to
121 //! <code>[Option]<[&mut] T::[Target]></code>
122 //! * [`as_pin_ref`] converts from <code>[Pin]<[&][][Option]\<T>></code> to
123 //! <code>[Option]<[Pin]<[&]T>></code>
124 //! * [`as_pin_mut`] converts from <code>[Pin]<[&mut] [Option]\<T>></code> to
125 //! <code>[Option]<[Pin]<[&mut] T>></code>
127 //! [&]: reference "shared reference"
128 //! [&mut]: reference "mutable reference"
129 //! [Target]: Deref::Target "ops::Deref::Target"
130 //! [`as_deref`]: Option::as_deref
131 //! [`as_deref_mut`]: Option::as_deref_mut
132 //! [`as_mut`]: Option::as_mut
133 //! [`as_pin_mut`]: Option::as_pin_mut
134 //! [`as_pin_ref`]: Option::as_pin_ref
135 //! [`as_ref`]: Option::as_ref
137 //! ## Extracting the contained value
139 //! These methods extract the contained value in an [`Option<T>`] when it
140 //! is the [`Some`] variant. If the [`Option`] is [`None`]:
142 //! * [`expect`] panics with a provided custom message
143 //! * [`unwrap`] panics with a generic message
144 //! * [`unwrap_or`] returns the provided default value
145 //! * [`unwrap_or_default`] returns the default value of the type `T`
146 //! (which must implement the [`Default`] trait)
147 //! * [`unwrap_or_else`] returns the result of evaluating the provided
150 //! [`expect`]: Option::expect
151 //! [`unwrap`]: Option::unwrap
152 //! [`unwrap_or`]: Option::unwrap_or
153 //! [`unwrap_or_default`]: Option::unwrap_or_default
154 //! [`unwrap_or_else`]: Option::unwrap_or_else
156 //! ## Transforming contained values
158 //! These methods transform [`Option`] to [`Result`]:
160 //! * [`ok_or`] transforms [`Some(v)`] to [`Ok(v)`], and [`None`] to
161 //! [`Err(err)`] using the provided default `err` value
162 //! * [`ok_or_else`] transforms [`Some(v)`] to [`Ok(v)`], and [`None`] to
163 //! a value of [`Err`] using the provided function
164 //! * [`transpose`] transposes an [`Option`] of a [`Result`] into a
165 //! [`Result`] of an [`Option`]
167 //! [`Err(err)`]: Err
169 //! [`Some(v)`]: Some
170 //! [`ok_or`]: Option::ok_or
171 //! [`ok_or_else`]: Option::ok_or_else
172 //! [`transpose`]: Option::transpose
174 //! These methods transform the [`Some`] variant:
176 //! * [`filter`] calls the provided predicate function on the contained
177 //! value `t` if the [`Option`] is [`Some(t)`], and returns [`Some(t)`]
178 //! if the function returns `true`; otherwise, returns [`None`]
179 //! * [`flatten`] removes one level of nesting from an
180 //! [`Option<Option<T>>`]
181 //! * [`map`] transforms [`Option<T>`] to [`Option<U>`] by applying the
182 //! provided function to the contained value of [`Some`] and leaving
183 //! [`None`] values unchanged
185 //! [`Some(t)`]: Some
186 //! [`filter`]: Option::filter
187 //! [`flatten`]: Option::flatten
188 //! [`map`]: Option::map
190 //! These methods transform [`Option<T>`] to a value of a possibly
191 //! different type `U`:
193 //! * [`map_or`] applies the provided function to the contained value of
194 //! [`Some`], or returns the provided default value if the [`Option`] is
196 //! * [`map_or_else`] applies the provided function to the contained value
197 //! of [`Some`], or returns the result of evaluating the provided
198 //! fallback function if the [`Option`] is [`None`]
200 //! [`map_or`]: Option::map_or
201 //! [`map_or_else`]: Option::map_or_else
203 //! These methods combine the [`Some`] variants of two [`Option`] values:
205 //! * [`zip`] returns [`Some((s, o))`] if `self` is [`Some(s)`] and the
206 //! provided [`Option`] value is [`Some(o)`]; otherwise, returns [`None`]
207 //! * [`zip_with`] calls the provided function `f` and returns
208 //! [`Some(f(s, o))`] if `self` is [`Some(s)`] and the provided
209 //! [`Option`] value is [`Some(o)`]; otherwise, returns [`None`]
211 //! [`Some(f(s, o))`]: Some
212 //! [`Some(o)`]: Some
213 //! [`Some(s)`]: Some
214 //! [`Some((s, o))`]: Some
215 //! [`zip`]: Option::zip
216 //! [`zip_with`]: Option::zip_with
218 //! ## Boolean operators
220 //! These methods treat the [`Option`] as a boolean value, where [`Some`]
221 //! acts like [`true`] and [`None`] acts like [`false`]. There are two
222 //! categories of these methods: ones that take an [`Option`] as input, and
223 //! ones that take a function as input (to be lazily evaluated).
225 //! The [`and`], [`or`], and [`xor`] methods take another [`Option`] as
226 //! input, and produce an [`Option`] as output. Only the [`and`] method can
227 //! produce an [`Option<U>`] value having a different inner type `U` than
230 //! | method | self | input | output |
231 //! |---------|-----------|-----------|-----------|
232 //! | [`and`] | `None` | (ignored) | `None` |
233 //! | [`and`] | `Some(x)` | `None` | `None` |
234 //! | [`and`] | `Some(x)` | `Some(y)` | `Some(y)` |
235 //! | [`or`] | `None` | `None` | `None` |
236 //! | [`or`] | `None` | `Some(y)` | `Some(y)` |
237 //! | [`or`] | `Some(x)` | (ignored) | `Some(x)` |
238 //! | [`xor`] | `None` | `None` | `None` |
239 //! | [`xor`] | `None` | `Some(y)` | `Some(y)` |
240 //! | [`xor`] | `Some(x)` | `None` | `Some(x)` |
241 //! | [`xor`] | `Some(x)` | `Some(y)` | `None` |
243 //! [`and`]: Option::and
244 //! [`or`]: Option::or
245 //! [`xor`]: Option::xor
247 //! The [`and_then`] and [`or_else`] methods take a function as input, and
248 //! only evaluate the function when they need to produce a new value. Only
249 //! the [`and_then`] method can produce an [`Option<U>`] value having a
250 //! different inner type `U` than [`Option<T>`].
252 //! | method | self | function input | function result | output |
253 //! |--------------|-----------|----------------|-----------------|-----------|
254 //! | [`and_then`] | `None` | (not provided) | (not evaluated) | `None` |
255 //! | [`and_then`] | `Some(x)` | `x` | `None` | `None` |
256 //! | [`and_then`] | `Some(x)` | `x` | `Some(y)` | `Some(y)` |
257 //! | [`or_else`] | `None` | (not provided) | `None` | `None` |
258 //! | [`or_else`] | `None` | (not provided) | `Some(y)` | `Some(y)` |
259 //! | [`or_else`] | `Some(x)` | (not provided) | (not evaluated) | `Some(x)` |
261 //! [`and_then`]: Option::and_then
262 //! [`or_else`]: Option::or_else
264 //! This is an example of using methods like [`and_then`] and [`or`] in a
265 //! pipeline of method calls. Early stages of the pipeline pass failure
266 //! values ([`None`]) through unchanged, and continue processing on
267 //! success values ([`Some`]). Toward the end, [`or`] substitutes an error
268 //! message if it receives [`None`].
271 //! # use std::collections::BTreeMap;
272 //! let mut bt = BTreeMap::new();
273 //! bt.insert(20u8, "foo");
274 //! bt.insert(42u8, "bar");
275 //! let res = [0u8, 1, 11, 200, 22]
278 //! // `checked_sub()` returns `None` on error
280 //! // same with `checked_mul()`
281 //! .and_then(|x| x.checked_mul(2))
282 //! // `BTreeMap::get` returns `None` on error
283 //! .and_then(|x| bt.get(&x))
284 //! // Substitute an error message if we have `None` so far
285 //! .or(Some(&"error!"))
287 //! // Won't panic because we unconditionally used `Some` above
290 //! .collect::<Vec<_>>();
291 //! assert_eq!(res, ["error!", "error!", "foo", "error!", "bar"]);
294 //! ## Comparison operators
296 //! If `T` implements [`PartialOrd`] then [`Option<T>`] will derive its
297 //! [`PartialOrd`] implementation. With this order, [`None`] compares as
298 //! less than any [`Some`], and two [`Some`] compare the same way as their
299 //! contained values would in `T`. If `T` also implements
300 //! [`Ord`], then so does [`Option<T>`].
303 //! assert!(None < Some(0));
304 //! assert!(Some(0) < Some(1));
307 //! ## Iterating over `Option`
309 //! An [`Option`] can be iterated over. This can be helpful if you need an
310 //! iterator that is conditionally empty. The iterator will either produce
311 //! a single value (when the [`Option`] is [`Some`]), or produce no values
312 //! (when the [`Option`] is [`None`]). For example, [`into_iter`] acts like
313 //! [`once(v)`] if the [`Option`] is [`Some(v)`], and like [`empty()`] if
314 //! the [`Option`] is [`None`].
316 //! [`Some(v)`]: Some
317 //! [`empty()`]: crate::iter::empty
318 //! [`once(v)`]: crate::iter::once
320 //! Iterators over [`Option<T>`] come in three types:
322 //! * [`into_iter`] consumes the [`Option`] and produces the contained
324 //! * [`iter`] produces an immutable reference of type `&T` to the
326 //! * [`iter_mut`] produces a mutable reference of type `&mut T` to the
329 //! [`into_iter`]: Option::into_iter
330 //! [`iter`]: Option::iter
331 //! [`iter_mut`]: Option::iter_mut
333 //! An iterator over [`Option`] can be useful when chaining iterators, for
334 //! example, to conditionally insert items. (It's not always necessary to
335 //! explicitly call an iterator constructor: many [`Iterator`] methods that
336 //! accept other iterators will also accept iterable types that implement
337 //! [`IntoIterator`], which includes [`Option`].)
340 //! let yep = Some(42);
342 //! // chain() already calls into_iter(), so we don't have to do so
343 //! let nums: Vec<i32> = (0..4).chain(yep).chain(4..8).collect();
344 //! assert_eq!(nums, [0, 1, 2, 3, 42, 4, 5, 6, 7]);
345 //! let nums: Vec<i32> = (0..4).chain(nope).chain(4..8).collect();
346 //! assert_eq!(nums, [0, 1, 2, 3, 4, 5, 6, 7]);
349 //! One reason to chain iterators in this way is that a function returning
350 //! `impl Iterator` must have all possible return values be of the same
351 //! concrete type. Chaining an iterated [`Option`] can help with that.
354 //! fn make_iter(do_insert: bool) -> impl Iterator<Item = i32> {
355 //! // Explicit returns to illustrate return types matching
356 //! match do_insert {
357 //! true => return (0..4).chain(Some(42)).chain(4..8),
358 //! false => return (0..4).chain(None).chain(4..8),
361 //! println!("{:?}", make_iter(true).collect::<Vec<_>>());
362 //! println!("{:?}", make_iter(false).collect::<Vec<_>>());
365 //! If we try to do the same thing, but using [`once()`] and [`empty()`],
366 //! we can't return `impl Iterator` anymore because the concrete types of
367 //! the return values differ.
369 //! [`empty()`]: crate::iter::empty
370 //! [`once()`]: crate::iter::once
372 //! ```compile_fail,E0308
373 //! # use std::iter::{empty, once};
374 //! // This won't compile because all possible returns from the function
375 //! // must have the same concrete type.
376 //! fn make_iter(do_insert: bool) -> impl Iterator<Item = i32> {
377 //! // Explicit returns to illustrate return types not matching
378 //! match do_insert {
379 //! true => return (0..4).chain(once(42)).chain(4..8),
380 //! false => return (0..4).chain(empty()).chain(4..8),
385 //! ## Collecting into `Option`
387 //! [`Option`] implements the [`FromIterator`][impl-FromIterator] trait,
388 //! which allows an iterator over [`Option`] values to be collected into an
389 //! [`Option`] of a collection of each contained value of the original
390 //! [`Option`] values, or [`None`] if any of the elements was [`None`].
392 //! [impl-FromIterator]: Option#impl-FromIterator%3COption%3CA%3E%3E-for-Option%3CV%3E
395 //! let v = [Some(2), Some(4), None, Some(8)];
396 //! let res: Option<Vec<_>> = v.into_iter().collect();
397 //! assert_eq!(res, None);
398 //! let v = [Some(2), Some(4), Some(8)];
399 //! let res: Option<Vec<_>> = v.into_iter().collect();
400 //! assert_eq!(res, Some(vec![2, 4, 8]));
403 //! [`Option`] also implements the [`Product`][impl-Product] and
404 //! [`Sum`][impl-Sum] traits, allowing an iterator over [`Option`] values
405 //! to provide the [`product`][Iterator::product] and
406 //! [`sum`][Iterator::sum] methods.
408 //! [impl-Product]: Option#impl-Product%3COption%3CU%3E%3E-for-Option%3CT%3E
409 //! [impl-Sum]: Option#impl-Sum%3COption%3CU%3E%3E-for-Option%3CT%3E
412 //! let v = [None, Some(1), Some(2), Some(3)];
413 //! let res: Option<i32> = v.into_iter().sum();
414 //! assert_eq!(res, None);
415 //! let v = [Some(1), Some(2), Some(21)];
416 //! let res: Option<i32> = v.into_iter().product();
417 //! assert_eq!(res, Some(42));
420 //! ## Modifying an [`Option`] in-place
422 //! These methods return a mutable reference to the contained value of an
425 //! * [`insert`] inserts a value, dropping any old contents
426 //! * [`get_or_insert`] gets the current value, inserting a provided
427 //! default value if it is [`None`]
428 //! * [`get_or_insert_default`] gets the current value, inserting the
429 //! default value of type `T` (which must implement [`Default`]) if it is
431 //! * [`get_or_insert_with`] gets the current value, inserting a default
432 //! computed by the provided function if it is [`None`]
434 //! [`get_or_insert`]: Option::get_or_insert
435 //! [`get_or_insert_default`]: Option::get_or_insert_default
436 //! [`get_or_insert_with`]: Option::get_or_insert_with
437 //! [`insert`]: Option::insert
439 //! These methods transfer ownership of the contained value of an
442 //! * [`take`] takes ownership of the contained value of an [`Option`], if
443 //! any, replacing the [`Option`] with [`None`]
444 //! * [`replace`] takes ownership of the contained value of an [`Option`],
445 //! if any, replacing the [`Option`] with a [`Some`] containing the
448 //! [`replace`]: Option::replace
449 //! [`take`]: Option::take
453 //! Basic pattern matching on [`Option`]:
456 //! let msg = Some("howdy");
458 //! // Take a reference to the contained string
459 //! if let Some(m) = &msg {
460 //! println!("{}", *m);
463 //! // Remove the contained string, destroying the Option
464 //! let unwrapped_msg = msg.unwrap_or("default message");
467 //! Initialize a result to [`None`] before a loop:
470 //! enum Kingdom { Plant(u32, &'static str), Animal(u32, &'static str) }
472 //! // A list of data to search through.
473 //! let all_the_big_things = [
474 //! Kingdom::Plant(250, "redwood"),
475 //! Kingdom::Plant(230, "noble fir"),
476 //! Kingdom::Plant(229, "sugar pine"),
477 //! Kingdom::Animal(25, "blue whale"),
478 //! Kingdom::Animal(19, "fin whale"),
479 //! Kingdom::Animal(15, "north pacific right whale"),
482 //! // We're going to search for the name of the biggest animal,
483 //! // but to start with we've just got `None`.
484 //! let mut name_of_biggest_animal = None;
485 //! let mut size_of_biggest_animal = 0;
486 //! for big_thing in &all_the_big_things {
487 //! match *big_thing {
488 //! Kingdom::Animal(size, name) if size > size_of_biggest_animal => {
489 //! // Now we've found the name of some big animal
490 //! size_of_biggest_animal = size;
491 //! name_of_biggest_animal = Some(name);
493 //! Kingdom::Animal(..) | Kingdom::Plant(..) => ()
497 //! match name_of_biggest_animal {
498 //! Some(name) => println!("the biggest animal is {name}"),
499 //! None => println!("there are no animals :("),
503 #![stable(feature = "rust1", since = "1.0.0")]
505 use crate::iter::{self, FromIterator, FusedIterator, TrustedLen};
506 use crate::marker::Destruct;
507 use crate::panicking::{panic, panic_str};
511 ops::{self, ControlFlow, Deref, DerefMut},
514 /// The `Option` type. See [the module level documentation](self) for more.
515 #[derive(Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)]
516 #[rustc_diagnostic_item = "Option"]
517 #[stable(feature = "rust1", since = "1.0.0")]
521 #[stable(feature = "rust1", since = "1.0.0")]
523 /// Some value of type `T`.
525 #[stable(feature = "rust1", since = "1.0.0")]
526 Some(#[stable(feature = "rust1", since = "1.0.0")] T),
529 /////////////////////////////////////////////////////////////////////////////
530 // Type implementation
531 /////////////////////////////////////////////////////////////////////////////
534 /////////////////////////////////////////////////////////////////////////
535 // Querying the contained values
536 /////////////////////////////////////////////////////////////////////////
538 /// Returns `true` if the option is a [`Some`] value.
543 /// let x: Option<u32> = Some(2);
544 /// assert_eq!(x.is_some(), true);
546 /// let x: Option<u32> = None;
547 /// assert_eq!(x.is_some(), false);
549 #[must_use = "if you intended to assert that this has a value, consider `.unwrap()` instead"]
551 #[stable(feature = "rust1", since = "1.0.0")]
552 #[rustc_const_stable(feature = "const_option_basics", since = "1.48.0")]
553 pub const fn is_some(&self) -> bool {
554 matches!(*self, Some(_))
557 /// Returns `true` if the option is a [`Some`] and the value inside of it matches a predicate.
562 /// #![feature(is_some_with)]
564 /// let x: Option<u32> = Some(2);
565 /// assert_eq!(x.is_some_and(|&x| x > 1), true);
567 /// let x: Option<u32> = Some(0);
568 /// assert_eq!(x.is_some_and(|&x| x > 1), false);
570 /// let x: Option<u32> = None;
571 /// assert_eq!(x.is_some_and(|&x| x > 1), false);
575 #[unstable(feature = "is_some_with", issue = "93050")]
576 pub fn is_some_and(&self, f: impl FnOnce(&T) -> bool) -> bool {
577 matches!(self, Some(x) if f(x))
580 /// Returns `true` if the option is a [`None`] value.
585 /// let x: Option<u32> = Some(2);
586 /// assert_eq!(x.is_none(), false);
588 /// let x: Option<u32> = None;
589 /// assert_eq!(x.is_none(), true);
591 #[must_use = "if you intended to assert that this doesn't have a value, consider \
592 `.and_then(|_| panic!(\"`Option` had a value when expected `None`\"))` instead"]
594 #[stable(feature = "rust1", since = "1.0.0")]
595 #[rustc_const_stable(feature = "const_option_basics", since = "1.48.0")]
596 pub const fn is_none(&self) -> bool {
600 /////////////////////////////////////////////////////////////////////////
601 // Adapter for working with references
602 /////////////////////////////////////////////////////////////////////////
604 /// Converts from `&Option<T>` to `Option<&T>`.
608 /// Converts an <code>Option<[String]></code> into an <code>Option<[usize]></code>, preserving
609 /// the original. The [`map`] method takes the `self` argument by value, consuming the original,
610 /// so this technique uses `as_ref` to first take an `Option` to a reference
611 /// to the value inside the original.
613 /// [`map`]: Option::map
614 /// [String]: ../../std/string/struct.String.html "String"
617 /// let text: Option<String> = Some("Hello, world!".to_string());
618 /// // First, cast `Option<String>` to `Option<&String>` with `as_ref`,
619 /// // then consume *that* with `map`, leaving `text` on the stack.
620 /// let text_length: Option<usize> = text.as_ref().map(|s| s.len());
621 /// println!("still can print text: {text:?}");
624 #[rustc_const_stable(feature = "const_option_basics", since = "1.48.0")]
625 #[stable(feature = "rust1", since = "1.0.0")]
626 pub const fn as_ref(&self) -> Option<&T> {
628 Some(ref x) => Some(x),
633 /// Converts from `&mut Option<T>` to `Option<&mut T>`.
638 /// let mut x = Some(2);
639 /// match x.as_mut() {
640 /// Some(v) => *v = 42,
643 /// assert_eq!(x, Some(42));
646 #[stable(feature = "rust1", since = "1.0.0")]
647 #[rustc_const_unstable(feature = "const_option", issue = "67441")]
648 pub const fn as_mut(&mut self) -> Option<&mut T> {
650 Some(ref mut x) => Some(x),
655 /// Converts from <code>[Pin]<[&]Option\<T>></code> to <code>Option<[Pin]<[&]T>></code>.
657 /// [&]: reference "shared reference"
660 #[stable(feature = "pin", since = "1.33.0")]
661 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
662 pub const fn as_pin_ref(self: Pin<&Self>) -> Option<Pin<&T>> {
663 match Pin::get_ref(self).as_ref() {
664 // SAFETY: `x` is guaranteed to be pinned because it comes from `self`
666 Some(x) => unsafe { Some(Pin::new_unchecked(x)) },
671 /// Converts from <code>[Pin]<[&mut] Option\<T>></code> to <code>Option<[Pin]<[&mut] T>></code>.
673 /// [&mut]: reference "mutable reference"
676 #[stable(feature = "pin", since = "1.33.0")]
677 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
678 pub const fn as_pin_mut(self: Pin<&mut Self>) -> Option<Pin<&mut T>> {
679 // SAFETY: `get_unchecked_mut` is never used to move the `Option` inside `self`.
680 // `x` is guaranteed to be pinned because it comes from `self` which is pinned.
682 match Pin::get_unchecked_mut(self).as_mut() {
683 Some(x) => Some(Pin::new_unchecked(x)),
689 /////////////////////////////////////////////////////////////////////////
690 // Getting to contained values
691 /////////////////////////////////////////////////////////////////////////
693 /// Returns the contained [`Some`] value, consuming the `self` value.
697 /// Panics if the value is a [`None`] with a custom panic message provided by
703 /// let x = Some("value");
704 /// assert_eq!(x.expect("fruits are healthy"), "value");
708 /// let x: Option<&str> = None;
709 /// x.expect("fruits are healthy"); // panics with `fruits are healthy`
712 /// # Recommended Message Style
714 /// We recommend that `expect` messages are used to describe the reason you
715 /// _expect_ the `Option` should be `Some`.
718 /// # let slice: &[u8] = &[];
719 /// let item = slice.get(0)
720 /// .expect("slice should not be empty");
723 /// **Hint**: If you're having trouble remembering how to phrase expect
724 /// error messages remember to focus on the word "should" as in "env
725 /// variable should be set by blah" or "the given binary should be available
726 /// and executable by the current user".
728 /// For more detail on expect message styles and the reasoning behind our
729 /// recommendation please refer to the section on ["Common Message
730 /// Styles"](../../std/error/index.html#common-message-styles) in the [`std::error`](../../std/error/index.html) module docs.
733 #[stable(feature = "rust1", since = "1.0.0")]
734 #[rustc_const_unstable(feature = "const_option", issue = "67441")]
735 pub const fn expect(self, msg: &str) -> T {
738 None => expect_failed(msg),
742 /// Returns the contained [`Some`] value, consuming the `self` value.
744 /// Because this function may panic, its use is generally discouraged.
745 /// Instead, prefer to use pattern matching and handle the [`None`]
746 /// case explicitly, or call [`unwrap_or`], [`unwrap_or_else`], or
747 /// [`unwrap_or_default`].
749 /// [`unwrap_or`]: Option::unwrap_or
750 /// [`unwrap_or_else`]: Option::unwrap_or_else
751 /// [`unwrap_or_default`]: Option::unwrap_or_default
755 /// Panics if the self value equals [`None`].
760 /// let x = Some("air");
761 /// assert_eq!(x.unwrap(), "air");
765 /// let x: Option<&str> = None;
766 /// assert_eq!(x.unwrap(), "air"); // fails
770 #[stable(feature = "rust1", since = "1.0.0")]
771 #[rustc_const_unstable(feature = "const_option", issue = "67441")]
772 pub const fn unwrap(self) -> T {
775 None => panic("called `Option::unwrap()` on a `None` value"),
779 /// Returns the contained [`Some`] value or a provided default.
781 /// Arguments passed to `unwrap_or` are eagerly evaluated; if you are passing
782 /// the result of a function call, it is recommended to use [`unwrap_or_else`],
783 /// which is lazily evaluated.
785 /// [`unwrap_or_else`]: Option::unwrap_or_else
790 /// assert_eq!(Some("car").unwrap_or("bike"), "car");
791 /// assert_eq!(None.unwrap_or("bike"), "bike");
794 #[stable(feature = "rust1", since = "1.0.0")]
795 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
796 pub const fn unwrap_or(self, default: T) -> T
806 /// Returns the contained [`Some`] value or computes it from a closure.
812 /// assert_eq!(Some(4).unwrap_or_else(|| 2 * k), 4);
813 /// assert_eq!(None.unwrap_or_else(|| 2 * k), 20);
816 #[stable(feature = "rust1", since = "1.0.0")]
817 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
818 pub const fn unwrap_or_else<F>(self, f: F) -> T
820 F: ~const FnOnce() -> T,
829 /// Returns the contained [`Some`] value or a default.
831 /// Consumes the `self` argument then, if [`Some`], returns the contained
832 /// value, otherwise if [`None`], returns the [default value] for that
837 /// Converts a string to an integer, turning poorly-formed strings
838 /// into 0 (the default value for integers). [`parse`] converts
839 /// a string to any other type that implements [`FromStr`], returning
840 /// [`None`] on error.
843 /// let good_year_from_input = "1909";
844 /// let bad_year_from_input = "190blarg";
845 /// // Result::ok() converts a Result<T> to an Option<T>
846 /// let good_year = good_year_from_input.parse().ok().unwrap_or_default();
847 /// let bad_year = bad_year_from_input.parse().ok().unwrap_or_default();
849 /// assert_eq!(1909, good_year);
850 /// assert_eq!(0, bad_year);
853 /// [default value]: Default::default
854 /// [`parse`]: str::parse
855 /// [`FromStr`]: crate::str::FromStr
857 #[stable(feature = "rust1", since = "1.0.0")]
858 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
859 pub const fn unwrap_or_default(self) -> T
865 None => Default::default(),
869 /// Returns the contained [`Some`] value, consuming the `self` value,
870 /// without checking that the value is not [`None`].
874 /// Calling this method on [`None`] is *[undefined behavior]*.
876 /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
881 /// let x = Some("air");
882 /// assert_eq!(unsafe { x.unwrap_unchecked() }, "air");
886 /// let x: Option<&str> = None;
887 /// assert_eq!(unsafe { x.unwrap_unchecked() }, "air"); // Undefined behavior!
891 #[stable(feature = "option_result_unwrap_unchecked", since = "1.58.0")]
892 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
893 pub const unsafe fn unwrap_unchecked(self) -> T {
894 debug_assert!(self.is_some());
897 // SAFETY: the safety contract must be upheld by the caller.
898 None => unsafe { hint::unreachable_unchecked() },
902 /////////////////////////////////////////////////////////////////////////
903 // Transforming contained values
904 /////////////////////////////////////////////////////////////////////////
906 /// Maps an `Option<T>` to `Option<U>` by applying a function to a contained value.
910 /// Converts an <code>Option<[String]></code> into an <code>Option<[usize]></code>, consuming
913 /// [String]: ../../std/string/struct.String.html "String"
915 /// let maybe_some_string = Some(String::from("Hello, World!"));
916 /// // `Option::map` takes self *by value*, consuming `maybe_some_string`
917 /// let maybe_some_len = maybe_some_string.map(|s| s.len());
919 /// assert_eq!(maybe_some_len, Some(13));
922 #[stable(feature = "rust1", since = "1.0.0")]
923 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
924 pub const fn map<U, F>(self, f: F) -> Option<U>
926 F: ~const FnOnce(T) -> U,
930 Some(x) => Some(f(x)),
935 /// Calls the provided closure with a reference to the contained value (if [`Some`]).
940 /// #![feature(result_option_inspect)]
942 /// let v = vec![1, 2, 3, 4, 5];
944 /// // prints "got: 4"
945 /// let x: Option<&usize> = v.get(3).inspect(|x| println!("got: {x}"));
947 /// // prints nothing
948 /// let x: Option<&usize> = v.get(5).inspect(|x| println!("got: {x}"));
951 #[unstable(feature = "result_option_inspect", issue = "91345")]
952 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
953 pub const fn inspect<F>(self, f: F) -> Self
955 F: ~const FnOnce(&T),
958 if let Some(ref x) = self {
965 /// Returns the provided default result (if none),
966 /// or applies a function to the contained value (if any).
968 /// Arguments passed to `map_or` are eagerly evaluated; if you are passing
969 /// the result of a function call, it is recommended to use [`map_or_else`],
970 /// which is lazily evaluated.
972 /// [`map_or_else`]: Option::map_or_else
977 /// let x = Some("foo");
978 /// assert_eq!(x.map_or(42, |v| v.len()), 3);
980 /// let x: Option<&str> = None;
981 /// assert_eq!(x.map_or(42, |v| v.len()), 42);
984 #[stable(feature = "rust1", since = "1.0.0")]
985 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
986 pub const fn map_or<U, F>(self, default: U, f: F) -> U
988 F: ~const FnOnce(T) -> U,
998 /// Computes a default function result (if none), or
999 /// applies a different function to the contained value (if any).
1006 /// let x = Some("foo");
1007 /// assert_eq!(x.map_or_else(|| 2 * k, |v| v.len()), 3);
1009 /// let x: Option<&str> = None;
1010 /// assert_eq!(x.map_or_else(|| 2 * k, |v| v.len()), 42);
1013 #[stable(feature = "rust1", since = "1.0.0")]
1014 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1015 pub const fn map_or_else<U, D, F>(self, default: D, f: F) -> U
1017 D: ~const FnOnce() -> U,
1019 F: ~const FnOnce(T) -> U,
1028 /// Transforms the `Option<T>` into a [`Result<T, E>`], mapping [`Some(v)`] to
1029 /// [`Ok(v)`] and [`None`] to [`Err(err)`].
1031 /// Arguments passed to `ok_or` are eagerly evaluated; if you are passing the
1032 /// result of a function call, it is recommended to use [`ok_or_else`], which is
1033 /// lazily evaluated.
1036 /// [`Err(err)`]: Err
1037 /// [`Some(v)`]: Some
1038 /// [`ok_or_else`]: Option::ok_or_else
1043 /// let x = Some("foo");
1044 /// assert_eq!(x.ok_or(0), Ok("foo"));
1046 /// let x: Option<&str> = None;
1047 /// assert_eq!(x.ok_or(0), Err(0));
1050 #[stable(feature = "rust1", since = "1.0.0")]
1051 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1052 pub const fn ok_or<E>(self, err: E) -> Result<T, E>
1062 /// Transforms the `Option<T>` into a [`Result<T, E>`], mapping [`Some(v)`] to
1063 /// [`Ok(v)`] and [`None`] to [`Err(err())`].
1066 /// [`Err(err())`]: Err
1067 /// [`Some(v)`]: Some
1072 /// let x = Some("foo");
1073 /// assert_eq!(x.ok_or_else(|| 0), Ok("foo"));
1075 /// let x: Option<&str> = None;
1076 /// assert_eq!(x.ok_or_else(|| 0), Err(0));
1079 #[stable(feature = "rust1", since = "1.0.0")]
1080 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1081 pub const fn ok_or_else<E, F>(self, err: F) -> Result<T, E>
1083 F: ~const FnOnce() -> E,
1092 /// Converts from `Option<T>` (or `&Option<T>`) to `Option<&T::Target>`.
1094 /// Leaves the original Option in-place, creating a new one with a reference
1095 /// to the original one, additionally coercing the contents via [`Deref`].
1100 /// let x: Option<String> = Some("hey".to_owned());
1101 /// assert_eq!(x.as_deref(), Some("hey"));
1103 /// let x: Option<String> = None;
1104 /// assert_eq!(x.as_deref(), None);
1106 #[stable(feature = "option_deref", since = "1.40.0")]
1107 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1108 pub const fn as_deref(&self) -> Option<&T::Target>
1112 match self.as_ref() {
1113 Some(t) => Some(t.deref()),
1118 /// Converts from `Option<T>` (or `&mut Option<T>`) to `Option<&mut T::Target>`.
1120 /// Leaves the original `Option` in-place, creating a new one containing a mutable reference to
1121 /// the inner type's [`Deref::Target`] type.
1126 /// let mut x: Option<String> = Some("hey".to_owned());
1127 /// assert_eq!(x.as_deref_mut().map(|x| {
1128 /// x.make_ascii_uppercase();
1130 /// }), Some("HEY".to_owned().as_mut_str()));
1132 #[stable(feature = "option_deref", since = "1.40.0")]
1133 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1134 pub const fn as_deref_mut(&mut self) -> Option<&mut T::Target>
1138 match self.as_mut() {
1139 Some(t) => Some(t.deref_mut()),
1144 /////////////////////////////////////////////////////////////////////////
1145 // Iterator constructors
1146 /////////////////////////////////////////////////////////////////////////
1148 /// Returns an iterator over the possibly contained value.
1153 /// let x = Some(4);
1154 /// assert_eq!(x.iter().next(), Some(&4));
1156 /// let x: Option<u32> = None;
1157 /// assert_eq!(x.iter().next(), None);
1160 #[rustc_const_unstable(feature = "const_option", issue = "67441")]
1161 #[stable(feature = "rust1", since = "1.0.0")]
1162 pub const fn iter(&self) -> Iter<'_, T> {
1163 Iter { inner: Item { opt: self.as_ref() } }
1166 /// Returns a mutable iterator over the possibly contained value.
1171 /// let mut x = Some(4);
1172 /// match x.iter_mut().next() {
1173 /// Some(v) => *v = 42,
1176 /// assert_eq!(x, Some(42));
1178 /// let mut x: Option<u32> = None;
1179 /// assert_eq!(x.iter_mut().next(), None);
1182 #[stable(feature = "rust1", since = "1.0.0")]
1183 pub fn iter_mut(&mut self) -> IterMut<'_, T> {
1184 IterMut { inner: Item { opt: self.as_mut() } }
1187 /////////////////////////////////////////////////////////////////////////
1188 // Boolean operations on the values, eager and lazy
1189 /////////////////////////////////////////////////////////////////////////
1191 /// Returns [`None`] if the option is [`None`], otherwise returns `optb`.
1193 /// Arguments passed to `and` are eagerly evaluated; if you are passing the
1194 /// result of a function call, it is recommended to use [`and_then`], which is
1195 /// lazily evaluated.
1197 /// [`and_then`]: Option::and_then
1202 /// let x = Some(2);
1203 /// let y: Option<&str> = None;
1204 /// assert_eq!(x.and(y), None);
1206 /// let x: Option<u32> = None;
1207 /// let y = Some("foo");
1208 /// assert_eq!(x.and(y), None);
1210 /// let x = Some(2);
1211 /// let y = Some("foo");
1212 /// assert_eq!(x.and(y), Some("foo"));
1214 /// let x: Option<u32> = None;
1215 /// let y: Option<&str> = None;
1216 /// assert_eq!(x.and(y), None);
1219 #[stable(feature = "rust1", since = "1.0.0")]
1220 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1221 pub const fn and<U>(self, optb: Option<U>) -> Option<U>
1232 /// Returns [`None`] if the option is [`None`], otherwise calls `f` with the
1233 /// wrapped value and returns the result.
1235 /// Some languages call this operation flatmap.
1240 /// fn sq_then_to_string(x: u32) -> Option<String> {
1241 /// x.checked_mul(x).map(|sq| sq.to_string())
1244 /// assert_eq!(Some(2).and_then(sq_then_to_string), Some(4.to_string()));
1245 /// assert_eq!(Some(1_000_000).and_then(sq_then_to_string), None); // overflowed!
1246 /// assert_eq!(None.and_then(sq_then_to_string), None);
1249 /// Often used to chain fallible operations that may return [`None`].
1252 /// let arr_2d = [["A0", "A1"], ["B0", "B1"]];
1254 /// let item_0_1 = arr_2d.get(0).and_then(|row| row.get(1));
1255 /// assert_eq!(item_0_1, Some(&"A1"));
1257 /// let item_2_0 = arr_2d.get(2).and_then(|row| row.get(0));
1258 /// assert_eq!(item_2_0, None);
1261 #[stable(feature = "rust1", since = "1.0.0")]
1262 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1263 pub const fn and_then<U, F>(self, f: F) -> Option<U>
1265 F: ~const FnOnce(T) -> Option<U>,
1274 /// Returns [`None`] if the option is [`None`], otherwise calls `predicate`
1275 /// with the wrapped value and returns:
1277 /// - [`Some(t)`] if `predicate` returns `true` (where `t` is the wrapped
1279 /// - [`None`] if `predicate` returns `false`.
1281 /// This function works similar to [`Iterator::filter()`]. You can imagine
1282 /// the `Option<T>` being an iterator over one or zero elements. `filter()`
1283 /// lets you decide which elements to keep.
1288 /// fn is_even(n: &i32) -> bool {
1292 /// assert_eq!(None.filter(is_even), None);
1293 /// assert_eq!(Some(3).filter(is_even), None);
1294 /// assert_eq!(Some(4).filter(is_even), Some(4));
1297 /// [`Some(t)`]: Some
1299 #[stable(feature = "option_filter", since = "1.27.0")]
1300 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1301 pub const fn filter<P>(self, predicate: P) -> Self
1304 P: ~const FnOnce(&T) -> bool,
1307 if let Some(x) = self {
1315 /// Returns the option if it contains a value, otherwise returns `optb`.
1317 /// Arguments passed to `or` are eagerly evaluated; if you are passing the
1318 /// result of a function call, it is recommended to use [`or_else`], which is
1319 /// lazily evaluated.
1321 /// [`or_else`]: Option::or_else
1326 /// let x = Some(2);
1328 /// assert_eq!(x.or(y), Some(2));
1331 /// let y = Some(100);
1332 /// assert_eq!(x.or(y), Some(100));
1334 /// let x = Some(2);
1335 /// let y = Some(100);
1336 /// assert_eq!(x.or(y), Some(2));
1338 /// let x: Option<u32> = None;
1340 /// assert_eq!(x.or(y), None);
1343 #[stable(feature = "rust1", since = "1.0.0")]
1344 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1345 pub const fn or(self, optb: Option<T>) -> Option<T>
1355 /// Returns the option if it contains a value, otherwise calls `f` and
1356 /// returns the result.
1361 /// fn nobody() -> Option<&'static str> { None }
1362 /// fn vikings() -> Option<&'static str> { Some("vikings") }
1364 /// assert_eq!(Some("barbarians").or_else(vikings), Some("barbarians"));
1365 /// assert_eq!(None.or_else(vikings), Some("vikings"));
1366 /// assert_eq!(None.or_else(nobody), None);
1369 #[stable(feature = "rust1", since = "1.0.0")]
1370 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1371 pub const fn or_else<F>(self, f: F) -> Option<T>
1373 F: ~const FnOnce() -> Option<T>,
1382 /// Returns [`Some`] if exactly one of `self`, `optb` is [`Some`], otherwise returns [`None`].
1387 /// let x = Some(2);
1388 /// let y: Option<u32> = None;
1389 /// assert_eq!(x.xor(y), Some(2));
1391 /// let x: Option<u32> = None;
1392 /// let y = Some(2);
1393 /// assert_eq!(x.xor(y), Some(2));
1395 /// let x = Some(2);
1396 /// let y = Some(2);
1397 /// assert_eq!(x.xor(y), None);
1399 /// let x: Option<u32> = None;
1400 /// let y: Option<u32> = None;
1401 /// assert_eq!(x.xor(y), None);
1404 #[stable(feature = "option_xor", since = "1.37.0")]
1405 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1406 pub const fn xor(self, optb: Option<T>) -> Option<T>
1410 match (self, optb) {
1411 (Some(a), None) => Some(a),
1412 (None, Some(b)) => Some(b),
1417 /////////////////////////////////////////////////////////////////////////
1418 // Entry-like operations to insert a value and return a reference
1419 /////////////////////////////////////////////////////////////////////////
1421 /// Inserts `value` into the option, then returns a mutable reference to it.
1423 /// If the option already contains a value, the old value is dropped.
1425 /// See also [`Option::get_or_insert`], which doesn't update the value if
1426 /// the option already contains [`Some`].
1431 /// let mut opt = None;
1432 /// let val = opt.insert(1);
1433 /// assert_eq!(*val, 1);
1434 /// assert_eq!(opt.unwrap(), 1);
1435 /// let val = opt.insert(2);
1436 /// assert_eq!(*val, 2);
1438 /// assert_eq!(opt.unwrap(), 3);
1440 #[must_use = "if you intended to set a value, consider assignment instead"]
1442 #[stable(feature = "option_insert", since = "1.53.0")]
1443 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1444 pub const fn insert(&mut self, value: T) -> &mut T
1448 *self = Some(value);
1450 // SAFETY: the code above just filled the option
1451 unsafe { self.as_mut().unwrap_unchecked() }
1454 /// Inserts `value` into the option if it is [`None`], then
1455 /// returns a mutable reference to the contained value.
1457 /// See also [`Option::insert`], which updates the value even if
1458 /// the option already contains [`Some`].
1463 /// let mut x = None;
1466 /// let y: &mut u32 = x.get_or_insert(5);
1467 /// assert_eq!(y, &5);
1472 /// assert_eq!(x, Some(7));
1475 #[stable(feature = "option_entry", since = "1.20.0")]
1476 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1477 pub const fn get_or_insert(&mut self, value: T) -> &mut T
1481 if let None = *self {
1482 *self = Some(value);
1485 // SAFETY: a `None` variant for `self` would have been replaced by a `Some`
1486 // variant in the code above.
1487 unsafe { self.as_mut().unwrap_unchecked() }
1490 /// Inserts the default value into the option if it is [`None`], then
1491 /// returns a mutable reference to the contained value.
1496 /// #![feature(option_get_or_insert_default)]
1498 /// let mut x = None;
1501 /// let y: &mut u32 = x.get_or_insert_default();
1502 /// assert_eq!(y, &0);
1507 /// assert_eq!(x, Some(7));
1510 #[unstable(feature = "option_get_or_insert_default", issue = "82901")]
1511 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1512 pub const fn get_or_insert_default(&mut self) -> &mut T
1516 const fn default<T: ~const Default>() -> T {
1520 self.get_or_insert_with(default)
1523 /// Inserts a value computed from `f` into the option if it is [`None`],
1524 /// then returns a mutable reference to the contained value.
1529 /// let mut x = None;
1532 /// let y: &mut u32 = x.get_or_insert_with(|| 5);
1533 /// assert_eq!(y, &5);
1538 /// assert_eq!(x, Some(7));
1541 #[stable(feature = "option_entry", since = "1.20.0")]
1542 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1543 pub const fn get_or_insert_with<F>(&mut self, f: F) -> &mut T
1545 F: ~const FnOnce() -> T,
1548 if let None = *self {
1549 // the compiler isn't smart enough to know that we are not dropping a `T`
1550 // here and wants us to ensure `T` can be dropped at compile time.
1551 mem::forget(mem::replace(self, Some(f())))
1554 // SAFETY: a `None` variant for `self` would have been replaced by a `Some`
1555 // variant in the code above.
1556 unsafe { self.as_mut().unwrap_unchecked() }
1559 /////////////////////////////////////////////////////////////////////////
1561 /////////////////////////////////////////////////////////////////////////
1563 /// Takes the value out of the option, leaving a [`None`] in its place.
1568 /// let mut x = Some(2);
1569 /// let y = x.take();
1570 /// assert_eq!(x, None);
1571 /// assert_eq!(y, Some(2));
1573 /// let mut x: Option<u32> = None;
1574 /// let y = x.take();
1575 /// assert_eq!(x, None);
1576 /// assert_eq!(y, None);
1579 #[stable(feature = "rust1", since = "1.0.0")]
1580 #[rustc_const_unstable(feature = "const_option", issue = "67441")]
1581 pub const fn take(&mut self) -> Option<T> {
1582 // FIXME replace `mem::replace` by `mem::take` when the latter is const ready
1583 mem::replace(self, None)
1586 /// Replaces the actual value in the option by the value given in parameter,
1587 /// returning the old value if present,
1588 /// leaving a [`Some`] in its place without deinitializing either one.
1593 /// let mut x = Some(2);
1594 /// let old = x.replace(5);
1595 /// assert_eq!(x, Some(5));
1596 /// assert_eq!(old, Some(2));
1598 /// let mut x = None;
1599 /// let old = x.replace(3);
1600 /// assert_eq!(x, Some(3));
1601 /// assert_eq!(old, None);
1604 #[rustc_const_unstable(feature = "const_option", issue = "67441")]
1605 #[stable(feature = "option_replace", since = "1.31.0")]
1606 pub const fn replace(&mut self, value: T) -> Option<T> {
1607 mem::replace(self, Some(value))
1610 /// Returns `true` if the option is a [`Some`] value containing the given value.
1615 /// #![feature(option_result_contains)]
1617 /// let x: Option<u32> = Some(2);
1618 /// assert_eq!(x.contains(&2), true);
1620 /// let x: Option<u32> = Some(3);
1621 /// assert_eq!(x.contains(&2), false);
1623 /// let x: Option<u32> = None;
1624 /// assert_eq!(x.contains(&2), false);
1628 #[unstable(feature = "option_result_contains", issue = "62358")]
1629 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1630 pub const fn contains<U>(&self, x: &U) -> bool
1632 U: ~const PartialEq<T>,
1640 /// Zips `self` with another `Option`.
1642 /// If `self` is `Some(s)` and `other` is `Some(o)`, this method returns `Some((s, o))`.
1643 /// Otherwise, `None` is returned.
1648 /// let x = Some(1);
1649 /// let y = Some("hi");
1650 /// let z = None::<u8>;
1652 /// assert_eq!(x.zip(y), Some((1, "hi")));
1653 /// assert_eq!(x.zip(z), None);
1655 #[stable(feature = "option_zip_option", since = "1.46.0")]
1656 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1657 pub const fn zip<U>(self, other: Option<U>) -> Option<(T, U)>
1662 match (self, other) {
1663 (Some(a), Some(b)) => Some((a, b)),
1668 /// Zips `self` and another `Option` with function `f`.
1670 /// If `self` is `Some(s)` and `other` is `Some(o)`, this method returns `Some(f(s, o))`.
1671 /// Otherwise, `None` is returned.
1676 /// #![feature(option_zip)]
1678 /// #[derive(Debug, PartialEq)]
1685 /// fn new(x: f64, y: f64) -> Self {
1690 /// let x = Some(17.5);
1691 /// let y = Some(42.7);
1693 /// assert_eq!(x.zip_with(y, Point::new), Some(Point { x: 17.5, y: 42.7 }));
1694 /// assert_eq!(x.zip_with(None, Point::new), None);
1696 #[unstable(feature = "option_zip", issue = "70086")]
1697 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1698 pub const fn zip_with<U, F, R>(self, other: Option<U>, f: F) -> Option<R>
1700 F: ~const FnOnce(T, U) -> R,
1705 match (self, other) {
1706 (Some(a), Some(b)) => Some(f(a, b)),
1712 impl<T, U> Option<(T, U)> {
1713 /// Unzips an option containing a tuple of two options.
1715 /// If `self` is `Some((a, b))` this method returns `(Some(a), Some(b))`.
1716 /// Otherwise, `(None, None)` is returned.
1721 /// #![feature(unzip_option)]
1723 /// let x = Some((1, "hi"));
1724 /// let y = None::<(u8, u32)>;
1726 /// assert_eq!(x.unzip(), (Some(1), Some("hi")));
1727 /// assert_eq!(y.unzip(), (None, None));
1730 #[unstable(feature = "unzip_option", issue = "87800", reason = "recently added")]
1731 pub const fn unzip(self) -> (Option<T>, Option<U>) {
1733 Some((a, b)) => (Some(a), Some(b)),
1734 None => (None, None),
1739 impl<T> Option<&T> {
1740 /// Maps an `Option<&T>` to an `Option<T>` by copying the contents of the
1747 /// let opt_x = Some(&x);
1748 /// assert_eq!(opt_x, Some(&12));
1749 /// let copied = opt_x.copied();
1750 /// assert_eq!(copied, Some(12));
1752 #[must_use = "`self` will be dropped if the result is not used"]
1753 #[stable(feature = "copied", since = "1.35.0")]
1754 #[rustc_const_unstable(feature = "const_option", issue = "67441")]
1755 pub const fn copied(self) -> Option<T>
1759 // FIXME: this implementation, which sidesteps using `Option::map` since it's not const
1760 // ready yet, should be reverted when possible to avoid code repetition
1762 Some(&v) => Some(v),
1767 /// Maps an `Option<&T>` to an `Option<T>` by cloning the contents of the
1774 /// let opt_x = Some(&x);
1775 /// assert_eq!(opt_x, Some(&12));
1776 /// let cloned = opt_x.cloned();
1777 /// assert_eq!(cloned, Some(12));
1779 #[must_use = "`self` will be dropped if the result is not used"]
1780 #[stable(feature = "rust1", since = "1.0.0")]
1781 #[rustc_const_unstable(feature = "const_option_cloned", issue = "91582")]
1782 pub const fn cloned(self) -> Option<T>
1787 Some(t) => Some(t.clone()),
1793 impl<T> Option<&mut T> {
1794 /// Maps an `Option<&mut T>` to an `Option<T>` by copying the contents of the
1801 /// let opt_x = Some(&mut x);
1802 /// assert_eq!(opt_x, Some(&mut 12));
1803 /// let copied = opt_x.copied();
1804 /// assert_eq!(copied, Some(12));
1806 #[must_use = "`self` will be dropped if the result is not used"]
1807 #[stable(feature = "copied", since = "1.35.0")]
1808 #[rustc_const_unstable(feature = "const_option_ext", issue = "91930")]
1809 pub const fn copied(self) -> Option<T>
1814 Some(&mut t) => Some(t),
1819 /// Maps an `Option<&mut T>` to an `Option<T>` by cloning the contents of the
1826 /// let opt_x = Some(&mut x);
1827 /// assert_eq!(opt_x, Some(&mut 12));
1828 /// let cloned = opt_x.cloned();
1829 /// assert_eq!(cloned, Some(12));
1831 #[must_use = "`self` will be dropped if the result is not used"]
1832 #[stable(since = "1.26.0", feature = "option_ref_mut_cloned")]
1833 #[rustc_const_unstable(feature = "const_option_cloned", issue = "91582")]
1834 pub const fn cloned(self) -> Option<T>
1839 Some(t) => Some(t.clone()),
1845 impl<T, E> Option<Result<T, E>> {
1846 /// Transposes an `Option` of a [`Result`] into a [`Result`] of an `Option`.
1848 /// [`None`] will be mapped to <code>[Ok]\([None])</code>.
1849 /// <code>[Some]\([Ok]\(\_))</code> and <code>[Some]\([Err]\(\_))</code> will be mapped to
1850 /// <code>[Ok]\([Some]\(\_))</code> and <code>[Err]\(\_)</code>.
1855 /// #[derive(Debug, Eq, PartialEq)]
1858 /// let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
1859 /// let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
1860 /// assert_eq!(x, y.transpose());
1863 #[stable(feature = "transpose_result", since = "1.33.0")]
1864 #[rustc_const_unstable(feature = "const_option", issue = "67441")]
1865 pub const fn transpose(self) -> Result<Option<T>, E> {
1867 Some(Ok(x)) => Ok(Some(x)),
1868 Some(Err(e)) => Err(e),
1874 // This is a separate function to reduce the code size of .expect() itself.
1875 #[cfg_attr(not(feature = "panic_immediate_abort"), inline(never))]
1876 #[cfg_attr(feature = "panic_immediate_abort", inline)]
1879 #[rustc_const_unstable(feature = "const_option", issue = "67441")]
1880 const fn expect_failed(msg: &str) -> ! {
1884 /////////////////////////////////////////////////////////////////////////////
1885 // Trait implementations
1886 /////////////////////////////////////////////////////////////////////////////
1888 #[stable(feature = "rust1", since = "1.0.0")]
1889 #[rustc_const_unstable(feature = "const_clone", issue = "91805")]
1890 impl<T> const Clone for Option<T>
1892 T: ~const Clone + ~const Destruct,
1895 fn clone(&self) -> Self {
1897 Some(x) => Some(x.clone()),
1903 fn clone_from(&mut self, source: &Self) {
1904 match (self, source) {
1905 (Some(to), Some(from)) => to.clone_from(from),
1906 (to, from) => *to = from.clone(),
1911 #[stable(feature = "rust1", since = "1.0.0")]
1912 #[rustc_const_unstable(feature = "const_default_impls", issue = "87864")]
1913 impl<T> const Default for Option<T> {
1914 /// Returns [`None`][Option::None].
1919 /// let opt: Option<u32> = Option::default();
1920 /// assert!(opt.is_none());
1923 fn default() -> Option<T> {
1928 #[stable(feature = "rust1", since = "1.0.0")]
1929 impl<T> IntoIterator for Option<T> {
1931 type IntoIter = IntoIter<T>;
1933 /// Returns a consuming iterator over the possibly contained value.
1938 /// let x = Some("string");
1939 /// let v: Vec<&str> = x.into_iter().collect();
1940 /// assert_eq!(v, ["string"]);
1943 /// let v: Vec<&str> = x.into_iter().collect();
1944 /// assert!(v.is_empty());
1947 fn into_iter(self) -> IntoIter<T> {
1948 IntoIter { inner: Item { opt: self } }
1952 #[stable(since = "1.4.0", feature = "option_iter")]
1953 impl<'a, T> IntoIterator for &'a Option<T> {
1955 type IntoIter = Iter<'a, T>;
1957 fn into_iter(self) -> Iter<'a, T> {
1962 #[stable(since = "1.4.0", feature = "option_iter")]
1963 impl<'a, T> IntoIterator for &'a mut Option<T> {
1964 type Item = &'a mut T;
1965 type IntoIter = IterMut<'a, T>;
1967 fn into_iter(self) -> IterMut<'a, T> {
1972 #[stable(since = "1.12.0", feature = "option_from")]
1973 #[rustc_const_unstable(feature = "const_convert", issue = "88674")]
1974 impl<T> const From<T> for Option<T> {
1975 /// Moves `val` into a new [`Some`].
1980 /// let o: Option<u8> = Option::from(67);
1982 /// assert_eq!(Some(67), o);
1984 fn from(val: T) -> Option<T> {
1989 #[stable(feature = "option_ref_from_ref_option", since = "1.30.0")]
1990 #[rustc_const_unstable(feature = "const_convert", issue = "88674")]
1991 impl<'a, T> const From<&'a Option<T>> for Option<&'a T> {
1992 /// Converts from `&Option<T>` to `Option<&T>`.
1996 /// Converts an <code>[Option]<[String]></code> into an <code>[Option]<[usize]></code>, preserving
1997 /// the original. The [`map`] method takes the `self` argument by value, consuming the original,
1998 /// so this technique uses `from` to first take an [`Option`] to a reference
1999 /// to the value inside the original.
2001 /// [`map`]: Option::map
2002 /// [String]: ../../std/string/struct.String.html "String"
2005 /// let s: Option<String> = Some(String::from("Hello, Rustaceans!"));
2006 /// let o: Option<usize> = Option::from(&s).map(|ss: &String| ss.len());
2008 /// println!("Can still print s: {s:?}");
2010 /// assert_eq!(o, Some(18));
2012 fn from(o: &'a Option<T>) -> Option<&'a T> {
2017 #[stable(feature = "option_ref_from_ref_option", since = "1.30.0")]
2018 #[rustc_const_unstable(feature = "const_convert", issue = "88674")]
2019 impl<'a, T> const From<&'a mut Option<T>> for Option<&'a mut T> {
2020 /// Converts from `&mut Option<T>` to `Option<&mut T>`
2025 /// let mut s = Some(String::from("Hello"));
2026 /// let o: Option<&mut String> = Option::from(&mut s);
2029 /// Some(t) => *t = String::from("Hello, Rustaceans!"),
2033 /// assert_eq!(s, Some(String::from("Hello, Rustaceans!")));
2035 fn from(o: &'a mut Option<T>) -> Option<&'a mut T> {
2040 /////////////////////////////////////////////////////////////////////////////
2041 // The Option Iterators
2042 /////////////////////////////////////////////////////////////////////////////
2044 #[derive(Clone, Debug)]
2049 impl<A> Iterator for Item<A> {
2053 fn next(&mut self) -> Option<A> {
2058 fn size_hint(&self) -> (usize, Option<usize>) {
2060 Some(_) => (1, Some(1)),
2061 None => (0, Some(0)),
2066 impl<A> DoubleEndedIterator for Item<A> {
2068 fn next_back(&mut self) -> Option<A> {
2073 impl<A> ExactSizeIterator for Item<A> {}
2074 impl<A> FusedIterator for Item<A> {}
2075 unsafe impl<A> TrustedLen for Item<A> {}
2077 /// An iterator over a reference to the [`Some`] variant of an [`Option`].
2079 /// The iterator yields one value if the [`Option`] is a [`Some`], otherwise none.
2081 /// This `struct` is created by the [`Option::iter`] function.
2082 #[stable(feature = "rust1", since = "1.0.0")]
2084 pub struct Iter<'a, A: 'a> {
2088 #[stable(feature = "rust1", since = "1.0.0")]
2089 impl<'a, A> Iterator for Iter<'a, A> {
2093 fn next(&mut self) -> Option<&'a A> {
2097 fn size_hint(&self) -> (usize, Option<usize>) {
2098 self.inner.size_hint()
2102 #[stable(feature = "rust1", since = "1.0.0")]
2103 impl<'a, A> DoubleEndedIterator for Iter<'a, A> {
2105 fn next_back(&mut self) -> Option<&'a A> {
2106 self.inner.next_back()
2110 #[stable(feature = "rust1", since = "1.0.0")]
2111 impl<A> ExactSizeIterator for Iter<'_, A> {}
2113 #[stable(feature = "fused", since = "1.26.0")]
2114 impl<A> FusedIterator for Iter<'_, A> {}
2116 #[unstable(feature = "trusted_len", issue = "37572")]
2117 unsafe impl<A> TrustedLen for Iter<'_, A> {}
2119 #[stable(feature = "rust1", since = "1.0.0")]
2120 impl<A> Clone for Iter<'_, A> {
2122 fn clone(&self) -> Self {
2123 Iter { inner: self.inner.clone() }
2127 /// An iterator over a mutable reference to the [`Some`] variant of an [`Option`].
2129 /// The iterator yields one value if the [`Option`] is a [`Some`], otherwise none.
2131 /// This `struct` is created by the [`Option::iter_mut`] function.
2132 #[stable(feature = "rust1", since = "1.0.0")]
2134 pub struct IterMut<'a, A: 'a> {
2135 inner: Item<&'a mut A>,
2138 #[stable(feature = "rust1", since = "1.0.0")]
2139 impl<'a, A> Iterator for IterMut<'a, A> {
2140 type Item = &'a mut A;
2143 fn next(&mut self) -> Option<&'a mut A> {
2147 fn size_hint(&self) -> (usize, Option<usize>) {
2148 self.inner.size_hint()
2152 #[stable(feature = "rust1", since = "1.0.0")]
2153 impl<'a, A> DoubleEndedIterator for IterMut<'a, A> {
2155 fn next_back(&mut self) -> Option<&'a mut A> {
2156 self.inner.next_back()
2160 #[stable(feature = "rust1", since = "1.0.0")]
2161 impl<A> ExactSizeIterator for IterMut<'_, A> {}
2163 #[stable(feature = "fused", since = "1.26.0")]
2164 impl<A> FusedIterator for IterMut<'_, A> {}
2165 #[unstable(feature = "trusted_len", issue = "37572")]
2166 unsafe impl<A> TrustedLen for IterMut<'_, A> {}
2168 /// An iterator over the value in [`Some`] variant of an [`Option`].
2170 /// The iterator yields one value if the [`Option`] is a [`Some`], otherwise none.
2172 /// This `struct` is created by the [`Option::into_iter`] function.
2173 #[derive(Clone, Debug)]
2174 #[stable(feature = "rust1", since = "1.0.0")]
2175 pub struct IntoIter<A> {
2179 #[stable(feature = "rust1", since = "1.0.0")]
2180 impl<A> Iterator for IntoIter<A> {
2184 fn next(&mut self) -> Option<A> {
2188 fn size_hint(&self) -> (usize, Option<usize>) {
2189 self.inner.size_hint()
2193 #[stable(feature = "rust1", since = "1.0.0")]
2194 impl<A> DoubleEndedIterator for IntoIter<A> {
2196 fn next_back(&mut self) -> Option<A> {
2197 self.inner.next_back()
2201 #[stable(feature = "rust1", since = "1.0.0")]
2202 impl<A> ExactSizeIterator for IntoIter<A> {}
2204 #[stable(feature = "fused", since = "1.26.0")]
2205 impl<A> FusedIterator for IntoIter<A> {}
2207 #[unstable(feature = "trusted_len", issue = "37572")]
2208 unsafe impl<A> TrustedLen for IntoIter<A> {}
2210 /////////////////////////////////////////////////////////////////////////////
2212 /////////////////////////////////////////////////////////////////////////////
2214 #[stable(feature = "rust1", since = "1.0.0")]
2215 impl<A, V: FromIterator<A>> FromIterator<Option<A>> for Option<V> {
2216 /// Takes each element in the [`Iterator`]: if it is [`None`][Option::None],
2217 /// no further elements are taken, and the [`None`][Option::None] is
2218 /// returned. Should no [`None`][Option::None] occur, a container of type
2219 /// `V` containing the values of each [`Option`] is returned.
2223 /// Here is an example which increments every integer in a vector.
2224 /// We use the checked variant of `add` that returns `None` when the
2225 /// calculation would result in an overflow.
2228 /// let items = vec![0_u16, 1, 2];
2230 /// let res: Option<Vec<u16>> = items
2232 /// .map(|x| x.checked_add(1))
2235 /// assert_eq!(res, Some(vec![1, 2, 3]));
2238 /// As you can see, this will return the expected, valid items.
2240 /// Here is another example that tries to subtract one from another list
2241 /// of integers, this time checking for underflow:
2244 /// let items = vec![2_u16, 1, 0];
2246 /// let res: Option<Vec<u16>> = items
2248 /// .map(|x| x.checked_sub(1))
2251 /// assert_eq!(res, None);
2254 /// Since the last element is zero, it would underflow. Thus, the resulting
2255 /// value is `None`.
2257 /// Here is a variation on the previous example, showing that no
2258 /// further elements are taken from `iter` after the first `None`.
2261 /// let items = vec![3_u16, 2, 1, 10];
2263 /// let mut shared = 0;
2265 /// let res: Option<Vec<u16>> = items
2267 /// .map(|x| { shared += x; x.checked_sub(2) })
2270 /// assert_eq!(res, None);
2271 /// assert_eq!(shared, 6);
2274 /// Since the third element caused an underflow, no further elements were taken,
2275 /// so the final value of `shared` is 6 (= `3 + 2 + 1`), not 16.
2277 fn from_iter<I: IntoIterator<Item = Option<A>>>(iter: I) -> Option<V> {
2278 // FIXME(#11084): This could be replaced with Iterator::scan when this
2279 // performance bug is closed.
2281 iter::try_process(iter.into_iter(), |i| i.collect())
2285 #[unstable(feature = "try_trait_v2", issue = "84277")]
2286 #[rustc_const_unstable(feature = "const_convert", issue = "88674")]
2287 impl<T> const ops::Try for Option<T> {
2289 type Residual = Option<convert::Infallible>;
2292 fn from_output(output: Self::Output) -> Self {
2297 fn branch(self) -> ControlFlow<Self::Residual, Self::Output> {
2299 Some(v) => ControlFlow::Continue(v),
2300 None => ControlFlow::Break(None),
2305 #[unstable(feature = "try_trait_v2", issue = "84277")]
2306 #[rustc_const_unstable(feature = "const_convert", issue = "88674")]
2307 impl<T> const ops::FromResidual for Option<T> {
2309 fn from_residual(residual: Option<convert::Infallible>) -> Self {
2316 #[unstable(feature = "try_trait_v2_yeet", issue = "96374")]
2317 impl<T> ops::FromResidual<ops::Yeet<()>> for Option<T> {
2319 fn from_residual(ops::Yeet(()): ops::Yeet<()>) -> Self {
2324 #[unstable(feature = "try_trait_v2_residual", issue = "91285")]
2325 #[rustc_const_unstable(feature = "const_try", issue = "74935")]
2326 impl<T> const ops::Residual<T> for Option<convert::Infallible> {
2327 type TryType = Option<T>;
2330 impl<T> Option<Option<T>> {
2331 /// Converts from `Option<Option<T>>` to `Option<T>`.
2338 /// let x: Option<Option<u32>> = Some(Some(6));
2339 /// assert_eq!(Some(6), x.flatten());
2341 /// let x: Option<Option<u32>> = Some(None);
2342 /// assert_eq!(None, x.flatten());
2344 /// let x: Option<Option<u32>> = None;
2345 /// assert_eq!(None, x.flatten());
2348 /// Flattening only removes one level of nesting at a time:
2351 /// let x: Option<Option<Option<u32>>> = Some(Some(Some(6)));
2352 /// assert_eq!(Some(Some(6)), x.flatten());
2353 /// assert_eq!(Some(6), x.flatten().flatten());
2356 #[stable(feature = "option_flattening", since = "1.40.0")]
2357 #[rustc_const_unstable(feature = "const_option", issue = "67441")]
2358 pub const fn flatten(self) -> Option<T> {
2360 Some(inner) => inner,