Enum core::option::Option

pub enum Option<T> {
    None,
    Some(T),
}

Option 类型。有关更多信息，请参见 模块级文档。

Variants

None

没有值。

Some(T)

T 类型的某些值。

Implementations

impl<T> Option<T>

pub const fn is_some(&self) -> bool

如果选项是 Some 值，则返回 true。

Examples

let x: Option<u32> = Some(2);
assert_eq!(x.is_some(), true);

let x: Option<u32> = None;
assert_eq!(x.is_some(), false);

pub fn is_some_and(self, f: impl FnOnce(T) -> bool) -> bool

如果选项是 Some 并且其中的值与谓词匹配，则返回 true。

Examples

let x: Option<u32> = Some(2);
assert_eq!(x.is_some_and(|x| x > 1), true);

let x: Option<u32> = Some(0);
assert_eq!(x.is_some_and(|x| x > 1), false);

let x: Option<u32> = None;
assert_eq!(x.is_some_and(|x| x > 1), false);

pub const fn is_none(&self) -> bool

如果选项是 None 值，则返回 true。

Examples

let x: Option<u32> = Some(2);
assert_eq!(x.is_none(), false);

let x: Option<u32> = None;
assert_eq!(x.is_none(), true);

pub const fn as_ref(&self) -> Option<&T>

从 &Option<T> 转换为 Option<&T>。

Examples

在不移动 String 的情况下将 Option<String> 的长度计算为 Option<usize>。 map 方法按值使用 self 参数，从而消耗了原始文件，因此该技术使用 as_ref 首先将 Option 引用给原始文件中的值。

let text: Option<String> = Some("Hello, world!".to_string());
// 首先，使用 `as_ref` 将 `Option<String>` 转换为 `Option<&String>`，然后在 `map` 上消费它，在栈上留下 `text`。
let text_length: Option<usize> = text.as_ref().map(|s| s.len());
println!("still can print text: {text:?}");

pub fn as_mut(&mut self) -> Option<&mut T>

从 &mut Option<T> 转换为 Option<&mut T>。

Examples

let mut x = Some(2);
match x.as_mut() {
    Some(v) => *v = 42,
    None => {},
}
assert_eq!(x, Some(42));

pub fn as_pin_ref(self: Pin<&Self>) -> Option<Pin<&T>>

从 Pin<&Option<T>> 到 Option<Pin<&T>>。

pub fn as_pin_mut(self: Pin<&mut Self>) -> Option<Pin<&mut T>>

转换自 Pin<&mut Option<T>> 到 Option<Pin<&mut T>>。

pub fn as_slice(&self) -> &[T]

🔬This is a nightly-only experimental API. (option_as_slice #108545)

返回包含值的一部分 (如果有)。如果这是 None，则返回一个空切片。 这对于在 Option 或切片上使用单一类型的迭代器很有用。

Note: 如果您有 Option<&T> 并希望获得 T 的一部分，您可以通过 opt.map_or(&[], std::slice::from_ref) 解包。

Examples

#![feature(option_as_slice)]

assert_eq!(
    [Some(1234).as_slice(), None.as_slice()],
    [&[1234][..], &[][..]],
);

这个函数的倒数是 (折扣借用) [_]::first:

#![feature(option_as_slice)]

for i in [Some(1234_u16), None] {
    assert_eq!(i.as_ref(), i.as_slice().first());
}

pub fn as_mut_slice(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (option_as_slice #108545)

返回包含值的可变切片 (如果有)。如果这是 None，则返回一个空切片。 这对于在 Option 或切片上使用单一类型的迭代器很有用。

Note: 如果您有一个 Option<&mut T> 而不是 &mut Option<T>，这个方法需要，您可以通过 opt.map_or(&mut [], std::slice::from_mut) 获得一个可变切片。

Examples

#![feature(option_as_slice)]

assert_eq!(
    [Some(1234).as_mut_slice(), None.as_mut_slice()],
    [&mut [1234][..], &mut [][..]],
);

结果是指向我们原始 Option 的零项或一项的可变切片:

#![feature(option_as_slice)]

let mut x = Some(1234);
x.as_mut_slice()[0] += 1;
assert_eq!(x, Some(1235));

此方法的逆 (折扣借用) 是 [_]::first_mut:

#![feature(option_as_slice)]

assert_eq!(Some(123).as_mut_slice().first_mut(), Some(&mut 123))

pub fn expect(self, msg: &str) -> T

返回包含 self 值的包含的 Some 值。

Panics

如果值为 None 并带有由 msg 提供的自定义 panic 消息，就会出现 panics。

Examples

let x = Some("value");
assert_eq!(x.expect("fruits are healthy"), "value");

let x: Option<&str> = None;
x.expect("fruits are healthy"); // `fruits are healthy` 的 panics

推荐的消息样式

我们建议使用 expect 消息来描述您期望 Option 应该是 Some 的原因。

let item = slice.get(0)
    .expect("slice should not be empty");

提示: 如果您无法记住如何表达预期错误消息，请记住将注意力集中在 “should” 上，就像在 “env 变量应该由 blah 设置” 或 “ 给定的二进制文件应该可由当前用户使用和执行“ 中一样。

有关期望消息样式的更多详细信息以及我们建议背后的原因，请参见 std::error 模块文档中有关 “常见的消息样式” 的部分。

pub fn unwrap(self) -> T

返回包含 self 值的包含的 Some 值。

由于此函数可能为 panic，因此通常不建议使用该函数。 相反，更喜欢使用模式匹配并显式处理 None 大小写，或者调用 unwrap_or，unwrap_or_else 或 unwrap_or_default。

Panics

如果 self 的值等于 None，就会出现 panics。

Examples

let x = Some("air");
assert_eq!(x.unwrap(), "air");

let x: Option<&str> = None;
assert_eq!(x.unwrap(), "air"); // fails

pub fn unwrap_or(self, default: T) -> T

返回包含的 Some 值或提供的默认值。

急切地评估传递给 unwrap_or 的参数； 如果要传递函数调用的结果，建议使用 unwrap_or_else，它是惰性求值的。

Examples

assert_eq!(Some("car").unwrap_or("bike"), "car");
assert_eq!(None.unwrap_or("bike"), "bike");

pub fn unwrap_or_else<F>(self, f: F) -> Twhere F: FnOnce() -> T,

返回包含的 Some 值或从闭包中计算得出。

Examples

let k = 10;
assert_eq!(Some(4).unwrap_or_else(|| 2 * k), 4);
assert_eq!(None.unwrap_or_else(|| 2 * k), 20);

pub fn unwrap_or_default(self) -> Twhere T: Default,

返回包含的 Some 值或默认值。

消费 self 参数，如果 Some，则返回所包含的值，否则，如果 None，则返回该类型的 默认值。

Examples

let x: Option<u32> = None;
let y: Option<u32> = Some(12);

assert_eq!(x.unwrap_or_default(), 0);
assert_eq!(y.unwrap_or_default(), 12);

pub unsafe fn unwrap_unchecked(self) -> T

返回包含 self 值的包含的 Some 值，而不检查该值是否不是 None。

Safety

在 None 上调用此方法是 undefined behavior。

Examples

let x = Some("air");
assert_eq!(unsafe { x.unwrap_unchecked() }, "air");

let x: Option<&str> = None;
assert_eq!(unsafe { x.unwrap_unchecked() }, "air"); // 未定义的行为！

pub fn map<U, F>(self, f: F) -> Option<U>where F: FnOnce(T) -> U,

Maps 通过将函数应用于包含的值 (如果是 Some) 或返回 None (如果是 None)，将 Option<T> 转换为 Option<U>。

Examples

将 Option<String> 的长度计算为 Option<usize>，使用原始数据:

let maybe_some_string = Some(String::from("Hello, World!"));
// `Option::map` 按值获取 self，消耗 `maybe_some_string`
let maybe_some_len = maybe_some_string.map(|s| s.len());
assert_eq!(maybe_some_len, Some(13));

let x: Option<&str> = None;
assert_eq!(x.map(|s| s.len()), None);

pub fn inspect<F>(self, f: F) -> Selfwhere F: FnOnce(&T),

🔬This is a nightly-only experimental API. (result_option_inspect #91345)

使用对包含值的引用调用提供的闭包 (如果 Some)。

Examples

#![feature(result_option_inspect)]

let v = vec![1, 2, 3, 4, 5];

// 打印 "got: 4"
let x: Option<&usize> = v.get(3).inspect(|x| println!("got: {x}"));

// 什么都不打印
let x: Option<&usize> = v.get(5).inspect(|x| println!("got: {x}"));

pub fn map_or<U, F>(self, default: U, f: F) -> Uwhere F: FnOnce(T) -> U,

返回提供的默认结果 (如果没有)，或将函数应用于包含的值 (如果有)。

传递给 map_or 的参数会被急切地评估； 如果要传递函数调用的结果，建议使用 map_or_else，它是延迟计算的。

Examples

let x = Some("foo");
assert_eq!(x.map_or(42, |v| v.len()), 3);

let x: Option<&str> = None;
assert_eq!(x.map_or(42, |v| v.len()), 42);

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> Uwhere D: FnOnce() -> U, F: FnOnce(T) -> U,

计算 default 函数的结果 (如果没有)，或将不同的函数应用于包含的值 (如果有)。

Examples

let k = 21;

let x = Some("foo");
assert_eq!(x.map_or_else(|| 2 * k, |v| v.len()), 3);

let x: Option<&str> = None;
assert_eq!(x.map_or_else(|| 2 * k, |v| v.len()), 42);

pub fn ok_or<E>(self, err: E) -> Result<T, E>

将 Option<T> 转换为 Result<T, E>，将 Some(v) 映射到 Ok(v)，将 None 映射到 Err(err)。

急切地评估传递给 ok_or 的参数； 如果要传递函数调用的结果，建议使用 ok_or_else，它是延迟计算的。

Examples

let x = Some("foo");
assert_eq!(x.ok_or(0), Ok("foo"));

let x: Option<&str> = None;
assert_eq!(x.ok_or(0), Err(0));

pub fn ok_or_else<E, F>(self, err: F) -> Result<T, E>where F: FnOnce() -> E,

将 Option<T> 转换为 Result<T, E>，将 Some(v) 映射到 Ok(v)，将 None 映射到 Err(err())。

Examples

let x = Some("foo");
assert_eq!(x.ok_or_else(|| 0), Ok("foo"));

let x: Option<&str> = None;
assert_eq!(x.ok_or_else(|| 0), Err(0));

pub fn as_deref(&self) -> Option<&T::Target>where T: Deref,

从 Option<T> (或 &Option<T>) 转换为 Option<&T::Target>。

将原始 Option 保留在原位，创建一个带有对原始 Option 的引用的新 Option，并通过 Deref 强制执行其内容。

Examples

let x: Option<String> = Some("hey".to_owned());
assert_eq!(x.as_deref(), Some("hey"));

let x: Option<String> = None;
assert_eq!(x.as_deref(), None);

pub fn as_deref_mut(&mut self) -> Option<&mut T::Target>where T: DerefMut,

从 Option<T> (或 &mut Option<T>) 转换为 Option<&mut T::Target>。

在这里保留原始的 Option，创建一个包含对内部类型的 Deref::Target 类型的可变引用的新的 Option。

Examples

let mut x: Option<String> = Some("hey".to_owned());
assert_eq!(x.as_deref_mut().map(|x| {
    x.make_ascii_uppercase();
    x
}), Some("HEY".to_owned().as_mut_str()));

pub fn iter(&self) -> Iter<'_, T>

返回可能包含的值的迭代器。

Examples

let x = Some(4);
assert_eq!(x.iter().next(), Some(&4));

let x: Option<u32> = None;
assert_eq!(x.iter().next(), None);

pub fn iter_mut(&mut self) -> IterMut<'_, T>

返回可能包含的值的可变迭代器。

Examples

let mut x = Some(4);
match x.iter_mut().next() {
    Some(v) => *v = 42,
    None => {},
}
assert_eq!(x, Some(42));

let mut x: Option<u32> = None;
assert_eq!(x.iter_mut().next(), None);

pub fn and<U>(self, optb: Option<U>) -> Option<U>

如果选项为 None，则返回 None; 否则，返回 optb。

传递给 and 的参数被热切地评估; 如果要传递函数调用的结果，建议使用 and_then，它是惰性求值的。

Examples

let x = Some(2);
let y: Option<&str> = None;
assert_eq!(x.and(y), None);

let x: Option<u32> = None;
let y = Some("foo");
assert_eq!(x.and(y), None);

let x = Some(2);
let y = Some("foo");
assert_eq!(x.and(y), Some("foo"));

let x: Option<u32> = None;
let y: Option<&str> = None;
assert_eq!(x.and(y), None);

pub fn and_then<U, F>(self, f: F) -> Option<U>where F: FnOnce(T) -> Option<U>,

如果选项为 None，则返回 None; 否则，使用包装的值调用 f，并返回结果。

一些语言调用此操作平面图。

Examples

fn sq_then_to_string(x: u32) -> Option<String> {
    x.checked_mul(x).map(|sq| sq.to_string())
}

assert_eq!(Some(2).and_then(sq_then_to_string), Some(4.to_string()));
assert_eq!(Some(1_000_000).and_then(sq_then_to_string), None); // overflowed!
assert_eq!(None.and_then(sq_then_to_string), None);

通常用于链接可能返回 None 的错误操作。

let arr_2d = [["A0", "A1"], ["B0", "B1"]];

let item_0_1 = arr_2d.get(0).and_then(|row| row.get(1));
assert_eq!(item_0_1, Some(&"A1"));

let item_2_0 = arr_2d.get(2).and_then(|row| row.get(0));
assert_eq!(item_2_0, None);

pub fn filter<P>(self, predicate: P) -> Selfwhere P: FnOnce(&T) -> bool,

如果选项为 None，则返回 None; 否则，使用包装的值调用 predicate 并返回：

• Some(t) 如果 predicate 返回 true (其中 t 是包装值)，并且
• None 如果 predicate 返回 false。

该函数的工作方式类似于 Iterator::filter()。 您可以想象 Option<T> 是一个或零个元素上的迭代器。 filter() 让您决定保留哪些元素。

Examples

fn is_even(n: &i32) -> bool {
    n % 2 == 0
}

assert_eq!(None.filter(is_even), None);
assert_eq!(Some(3).filter(is_even), None);
assert_eq!(Some(4).filter(is_even), Some(4));

pub fn or(self, optb: Option<T>) -> Option<T>

如果包含值，则返回选项，否则返回 optb。

传递给 or 的参数会被急切地评估； 如果要传递函数调用的结果，建议使用 or_else，它是延迟计算的。

Examples

let x = Some(2);
let y = None;
assert_eq!(x.or(y), Some(2));

let x = None;
let y = Some(100);
assert_eq!(x.or(y), Some(100));

let x = Some(2);
let y = Some(100);
assert_eq!(x.or(y), Some(2));

let x: Option<u32> = None;
let y = None;
assert_eq!(x.or(y), None);

pub fn or_else<F>(self, f: F) -> Option<T>where F: FnOnce() -> Option<T>,

如果选项包含值，则返回该选项，否则调用 f 并返回结果。

Examples

fn nobody() -> Option<&'static str> { None }
fn vikings() -> Option<&'static str> { Some("vikings") }

assert_eq!(Some("barbarians").or_else(vikings), Some("barbarians"));
assert_eq!(None.or_else(vikings), Some("vikings"));
assert_eq!(None.or_else(nobody), None);

pub fn xor(self, optb: Option<T>) -> Option<T>

如果 self，optb 之一恰好是 Some，则返回 Some，否则返回 None。

Examples

let x = Some(2);
let y: Option<u32> = None;
assert_eq!(x.xor(y), Some(2));

let x: Option<u32> = None;
let y = Some(2);
assert_eq!(x.xor(y), Some(2));

let x = Some(2);
let y = Some(2);
assert_eq!(x.xor(y), None);

let x: Option<u32> = None;
let y: Option<u32> = None;
assert_eq!(x.xor(y), None);

pub fn insert(&mut self, value: T) -> &mut T

将 value 插入到选项，然后返回对它的可变引用。

如果该选项已包含值，则将丢弃旧值。

另请参见 Option::get_or_insert，如果选项已包含 Some，则不会更新值。

Example

let mut opt = None;
let val = opt.insert(1);
assert_eq!(*val, 1);
assert_eq!(opt.unwrap(), 1);
let val = opt.insert(2);
assert_eq!(*val, 2);
*val = 3;
assert_eq!(opt.unwrap(), 3);

pub fn get_or_insert(&mut self, value: T) -> &mut T

如果为 None，则将 value 插入到选项中，然后返回所包含的值的变量引用。

另请参见 Option::insert，即使选项已包含 Some，它也会更新值。

Examples

let mut x = None;

{
    let y: &mut u32 = x.get_or_insert(5);
    assert_eq!(y, &5);

    *y = 7;
}

assert_eq!(x, Some(7));

pub fn get_or_insert_default(&mut self) -> &mut Twhere T: Default,

🔬This is a nightly-only experimental API. (option_get_or_insert_default #82901)

如果默认值为 None，则将其插入选项中，然后将所包含的值返回变量引用。

Examples

#![feature(option_get_or_insert_default)]

let mut x = None;

{
    let y: &mut u32 = x.get_or_insert_default();
    assert_eq!(y, &0);

    *y = 7;
}

assert_eq!(x, Some(7));

pub fn get_or_insert_with<F>(&mut self, f: F) -> &mut Twhere F: FnOnce() -> T,

如果从 f 计算得出的值是 None，则将其插入选项中，然后将所包含的值返回可变引用。

Examples

let mut x = None;

{
    let y: &mut u32 = x.get_or_insert_with(|| 5);
    assert_eq!(y, &5);

    *y = 7;
}

assert_eq!(x, Some(7));

pub fn take(&mut self) -> Option<T>

从选项中取出值，将 None 留在其位置。

Examples

let mut x = Some(2);
let y = x.take();
assert_eq!(x, None);
assert_eq!(y, Some(2));

let mut x: Option<u32> = None;
let y = x.take();
assert_eq!(x, None);
assert_eq!(y, None);

pub fn replace(&mut self, value: T) -> Option<T>

用参数中给定的值替换选项中的实际值，如果存在则返回旧值，将 Some 保留在其位置，而不用对其中一个进行初始化。

Examples

let mut x = Some(2);
let old = x.replace(5);
assert_eq!(x, Some(5));
assert_eq!(old, Some(2));

let mut x = None;
let old = x.replace(3);
assert_eq!(x, Some(3));
assert_eq!(old, None);

pub fn zip<U>(self, other: Option<U>) -> Option<(T, U)>

用另一个 Option 压缩 self。

如果 self 是 Some(s)，而 other 是 Some(o)，则此方法返回 Some((s, o))。 否则，返回 None。

Examples

let x = Some(1);
let y = Some("hi");
let z = None::<u8>;

assert_eq!(x.zip(y), Some((1, "hi")));
assert_eq!(x.zip(z), None);

pub fn zip_with<U, F, R>(self, other: Option<U>, f: F) -> Option<R>where F: FnOnce(T, U) -> R,

🔬This is a nightly-only experimental API. (option_zip #70086)

使用函数 f 压缩 self 和另一个 Option。

如果 self 是 Some(s)，而 other 是 Some(o)，则此方法返回 Some(f(s, o))。 否则，返回 None。

Examples

#![feature(option_zip)]

#[derive(Debug, PartialEq)]
struct Point {
    x: f64,
    y: f64,
}

impl Point {
    fn new(x: f64, y: f64) -> Self {
        Self { x, y }
    }
}

let x = Some(17.5);
let y = Some(42.7);

assert_eq!(x.zip_with(y, Point::new), Some(Point { x: 17.5, y: 42.7 }));
assert_eq!(x.zip_with(None, Point::new), None);

impl<T, U> Option<(T, U)>

pub fn unzip(self) -> (Option<T>, Option<U>)

解压缩包含两个选项的元组的选项。

如果 self 是 Some((a, b))，则此方法返回 (Some(a), Some(b))。 否则，返回 (None, None)。

Examples

let x = Some((1, "hi"));
let y = None::<(u8, u32)>;

assert_eq!(x.unzip(), (Some(1), Some("hi")));
assert_eq!(y.unzip(), (None, None));

impl<T> Option<&T>

pub fn copied(self) -> Option<T>where T: Copy,

通过复制选项的内容将 Option<&T> 的 Maps 转换为 Option<T>。

Examples

let x = 12;
let opt_x = Some(&x);
assert_eq!(opt_x, Some(&12));
let copied = opt_x.copied();
assert_eq!(copied, Some(12));

pub fn cloned(self) -> Option<T>where T: Clone,

通过克隆选项的内容将 Option<&T> Maps 转换为 Option<T>。

Examples

let x = 12;
let opt_x = Some(&x);
assert_eq!(opt_x, Some(&12));
let cloned = opt_x.cloned();
assert_eq!(cloned, Some(12));

impl<T> Option<&mut T>

pub fn copied(self) -> Option<T>where T: Copy,

通过复制选项的内容将 Option<&mut T> 的 Maps 转换为 Option<T>。

Examples

let mut x = 12;
let opt_x = Some(&mut x);
assert_eq!(opt_x, Some(&mut 12));
let copied = opt_x.copied();
assert_eq!(copied, Some(12));

pub fn cloned(self) -> Option<T>where T: Clone,

通过克隆选项的内容将 Option<&mut T> Maps 转换为 Option<T>。

Examples

let mut x = 12;
let opt_x = Some(&mut x);
assert_eq!(opt_x, Some(&mut 12));
let cloned = opt_x.cloned();
assert_eq!(cloned, Some(12));

impl<T, E> Option<Result<T, E>>

pub fn transpose(self) -> Result<Option<T>, E>

将 Result 的 Option 转换为 Option 的 Result。

None 将映射到 Ok(None)。 Some(Ok(_)) 和 Some(Err(_)) 将映射到 Ok(Some(_)) 和 Err(_)。

Examples

#[derive(Debug, Eq, PartialEq)]
struct SomeErr;

let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
assert_eq!(x, y.transpose());

impl<T> Option<Option<T>>

pub fn flatten(self) -> Option<T>

从 Option<Option<T>> 转换为 Option<T>。

Examples

基本用法：

let x: Option<Option<u32>> = Some(Some(6));
assert_eq!(Some(6), x.flatten());

let x: Option<Option<u32>> = Some(None);
assert_eq!(None, x.flatten());

let x: Option<Option<u32>> = None;
assert_eq!(None, x.flatten());

展平一次只能删除一层嵌套：

let x: Option<Option<Option<u32>>> = Some(Some(Some(6)));
assert_eq!(Some(Some(6)), x.flatten());
assert_eq!(Some(6), x.flatten().flatten());

Trait Implementations

impl<T> Clone for Option<T>where T: Clone,

fn clone(&self) -> Self

返回值的副本。

fn clone_from(&mut self, source: &Self)

从 source 执行复制分配。

impl<T: Debug> Debug for Option<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

使用给定的格式化程序格式化该值。

impl<T> Default for Option<T>

fn default() -> Option<T>

返回 None。

Examples

let opt: Option<u32> = Option::default();
assert!(opt.is_none());

impl<'a, T> From<&'a Option<T>> for Option<&'a T>

fn from(o: &'a Option<T>) -> Option<&'a T>

从 &Option<T> 转换为 Option<&T>。

Examples

将 Option<String> 转换为 Option<usize>，保留原始值。 map 方法按值取 self 参数，消耗原始值，因此该技术使用 from 首先将 Option 用于对原始值内部值的引用。

let s: Option<String> = Some(String::from("Hello, Rustaceans!"));
let o: Option<usize> = Option::from(&s).map(|ss: &String| ss.len());

println!("Can still print s: {s:?}");

assert_eq!(o, Some(18));

impl<'a, T> From<&'a mut Option<T>> for Option<&'a mut T>

fn from(o: &'a mut Option<T>) -> Option<&'a mut T>

从 &mut Option<T> 转换为 Option<&mut T>

Examples

let mut s = Some(String::from("Hello"));
let o: Option<&mut String> = Option::from(&mut s);

match o {
    Some(t) => *t = String::from("Hello, Rustaceans!"),
    None => (),
}

assert_eq!(s, Some(String::from("Hello, Rustaceans!")));

impl<T> From<T> for Option<T>

fn from(val: T) -> Option<T>

将 val 移动到新的 Some 中。

Examples

let o: Option<u8> = Option::from(67);

assert_eq!(Some(67), o);

impl<A, V: FromIterator<A>> FromIterator<Option<A>> for Option<V>

fn from_iter<I: IntoIterator<Item = Option<A>>>(iter: I) -> Option<V>

接受 Iterator 中的每个元素：如果为 None，则不再获取其他元素，并返回 None。 如果没有出现 None，则返回一个 V 类型的容器，其中包含每个 Option 的值。

Examples

这是一个使 vector 中的每个整数递增的示例。 当计算将导致溢出时，我们使用 add 的检查变体返回 None。

let items = vec![0_u16, 1, 2];

let res: Option<Vec<u16>> = items
    .iter()
    .map(|x| x.checked_add(1))
    .collect();

assert_eq!(res, Some(vec![1, 2, 3]));

如您所见，这将返回预期的有效项。

这是另一个示例，尝试从另一个整数列表中减去一个，这次检查下溢：

let items = vec![2_u16, 1, 0];

let res: Option<Vec<u16>> = items
    .iter()
    .map(|x| x.checked_sub(1))
    .collect();

assert_eq!(res, None);

由于最后一个元素为零，因此会下溢。因此，结果值为 None。

这是前一个示例的变体，显示在第一个 None 之后不再从 iter 提取其他元素。

let items = vec![3_u16, 2, 1, 10];

let mut shared = 0;

let res: Option<Vec<u16>> = items
    .iter()
    .map(|x| { shared += x; x.checked_sub(2) })
    .collect();

assert_eq!(res, None);
assert_eq!(shared, 6);

由于第三个元素引起下溢，因此不再使用其他元素，因此 shared 的最终值为 6 (= 3 + 2 + 1)，而不是 16。

impl<T> FromResidual<<Option<T> as Try>::Residual> for Option<T>

fn from_residual(residual: Option<Infallible>) -> Self

🔬This is a nightly-only experimental API. (try_trait_v2 #84277)

从兼容的 Residual 类型构造类型。

impl<T> FromResidual<Yeet<()>> for Option<T>

fn from_residual(ops::Yeet: Yeet<()>) -> Self

🔬This is a nightly-only experimental API. (try_trait_v2 #84277)

从兼容的 Residual 类型构造类型。

impl<T: Hash> Hash for Option<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

将该值输入给定的 Hasher。

fn hash_slice<H: Hasher>(data: &[Self], state: &mut H)where Self: Sized,

将这种类型的切片送入给定的 Hasher 中。

impl<'a, T> IntoIterator for &'a Option<T>

type Item = &'a T

被迭代的元素的类型。

type IntoIter = Iter<'a, T>

我们将其变成哪种迭代器？

fn into_iter(self) -> Iter<'a, T>

从一个值创建一个迭代器。

impl<'a, T> IntoIterator for &'a mut Option<T>

type Item = &'a mut T

被迭代的元素的类型。

type IntoIter = IterMut<'a, T>

我们将其变成哪种迭代器？

fn into_iter(self) -> IterMut<'a, T>

从一个值创建一个迭代器。

impl<T> IntoIterator for Option<T>

fn into_iter(self) -> IntoIter<T>

返回可能包含的值上的消耗迭代器。

Examples

let x = Some("string");
let v: Vec<&str> = x.into_iter().collect();
assert_eq!(v, ["string"]);

let x = None;
let v: Vec<&str> = x.into_iter().collect();
assert!(v.is_empty());

type Item = T

被迭代的元素的类型。

type IntoIter = IntoIter<T>

我们将其变成哪种迭代器？

impl<T: Ord> Ord for Option<T>

fn cmp(&self, other: &Option<T>) -> Ordering

此方法返回 self 和 other 之间的 Ordering。

fn max(self, other: Self) -> Selfwhere Self: Sized,

比较并返回两个值中的最大值。

fn min(self, other: Self) -> Selfwhere Self: Sized,

比较并返回两个值中的最小值。

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

将值限制在某个时间间隔内。

impl<T: PartialEq> PartialEq<Option<T>> for Option<T>

fn eq(&self, other: &Self) -> bool

此方法测试 self 和 other 值是否相等，并由 == 使用。

fn ne(&self, other: &Rhs) -> bool

此方法测试 !=。 默认实现几乎总是足够的，并且不应在没有充分理由的情况下被覆盖。

impl<T: PartialOrd> PartialOrd<Option<T>> for Option<T>

fn partial_cmp(&self, other: &Option<T>) -> Option<Ordering>

如果存在，则此方法返回 self 和 other 值之间的顺序。

fn lt(&self, other: &Rhs) -> bool

此方法测试的内容少于 (对于 self 和 other)，并且由 < 操作员使用。

fn le(&self, other: &Rhs) -> bool

此方法测试小于或等于 (对于 self 和 other)，并且由 <= 运算符使用。

fn gt(&self, other: &Rhs) -> bool

此方法测试大于 (对于 self 和 other)，并且由 > 操作员使用。

fn ge(&self, other: &Rhs) -> bool

此方法测试是否大于或等于 (对于 self 和 other)，并且由 >= 运算符使用。

impl<T, U> Product<Option<U>> for Option<T>where T: Product<U>,

fn product<I>(iter: I) -> Option<T>where I: Iterator<Item = Option<U>>,

接受 Iterator 中的每个元素：如果它是 None，则不再获取其他元素，并返回 None。 如果没有发生 None，则返回所有元素的乘积。

Examples

这会将字符串 vector 中的每个数字相乘，如果无法解析字符串，则操作返回 None:

let nums = vec!["5", "10", "1", "2"];
let total: Option<usize> = nums.iter().map(|w| w.parse::<usize>().ok()).product();
assert_eq!(total, Some(100));
let nums = vec!["5", "10", "one", "2"];
let total: Option<usize> = nums.iter().map(|w| w.parse::<usize>().ok()).product();
assert_eq!(total, None);

impl<T> Residual<T> for Option<Infallible>

type TryType = Option<T>

🔬This is a nightly-only experimental API. (try_trait_v2_residual #91285)

此元函数的 “return” 类型。

impl<T, U> Sum<Option<U>> for Option<T>where T: Sum<U>,

fn sum<I>(iter: I) -> Option<T>where I: Iterator<Item = Option<U>>,

接受 Iterator 中的每个元素：如果它是 None，则不再获取其他元素，并返回 None。 如果没有发生 None，则返回所有元素的总和。

Examples

这总结了字符 ‘a’ 在字符串 vector 中的位置，如果单词没有字符 ‘a’，则该操作返回 None：

let words = vec!["have", "a", "great", "day"];
let total: Option<usize> = words.iter().map(|w| w.find('a')).sum();
assert_eq!(total, Some(5));
let words = vec!["have", "a", "good", "day"];
let total: Option<usize> = words.iter().map(|w| w.find('a')).sum();
assert_eq!(total, None);

impl<T> Try for Option<T>

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2 #84277)

当不短路时，? 产生的值的类型。

type Residual = Option<Infallible>

🔬This is a nightly-only experimental API. (try_trait_v2 #84277)

短路时作为 ? 的一部分传递给 FromResidual::from_residual 的值的类型。

fn from_output(output: Self::Output) -> Self

🔬This is a nightly-only experimental API. (try_trait_v2 #84277)

从它的 Output 类型构造类型。

fn branch(self) -> ControlFlow<Self::Residual, Self::Output>

🔬This is a nightly-only experimental API. (try_trait_v2 #84277)

在 ? 来决定操作符是应该生成一个值 (因为它返回了 ControlFlow::Continue)，还是将一个值传播回调用者 (因为它返回了 ControlFlow::Break)。

impl<T: Copy> Copy for Option<T>

impl<T: Eq> Eq for Option<T>

impl<T> StructuralEq for Option<T>

impl<T> StructuralPartialEq for Option<T>