Mirrors/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2026-05-04 09:53:04 +03:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #88648 - kpreid:option, r=Mark-Simulacrum

Browse Source 
Correct “copies” to “moves” in `<Option<T> as From<T>>::from` doc, and other copyediting

The `impl<T> From<T> for Option<T>` has no `Copy` or `Clone` bound, so its operation is guaranteed to be a move. The call site might copy, but the function itself cannot.

Since that would have been a rather small PR, I also reviewed the other documentation in the file and made other improvements (in separate commits): adding periods and commas, linking `Deref::Target`, and clarifying what "a container" is in `FromIterator`.
This commit is contained in:
Jack Huey
2021-09-08 12:24:18 -04:00
committed by GitHub
parent b1c782f20b 9a3a2a1c37
commit 2bbcf929c6
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
library/core/src/option.rs
+8 -8
View File
@@ -1173,7 +1173,7 @@ pub fn xor(self, optb: Option<T>) -> Option<T> {
// Entry-like operations to insert a value and return a reference
/////////////////////////////////////////////////////////////////////////
/// Inserts `value` into the option then returns a mutable reference to it.
/// Inserts `value` into the option, then returns a mutable reference to it.
///
/// If the option already contains a value, the old value is dropped.
///
@@ -1397,7 +1397,7 @@ pub fn zip_with<U, F, R>(self, other: Option<U>, f: F) -> Option<R>
}
impl<T, U> Option<(T, U)> {
/// Unzips an option containing a tuple of two options
/// Unzips an option containing a tuple of two options.
///
/// If `self` is `Some((a, b))` this method returns `(Some(a), Some(b))`.
/// Otherwise, `(None, None)` is returned.
@@ -1500,7 +1500,7 @@ pub fn cloned(self) -> Option<T> {
}
impl<T: Default> Option<T> {
/// Returns the contained [`Some`] value or a default
/// Returns the contained [`Some`] value or a default.
///
/// Consumes the `self` argument then, if [`Some`], returns the contained
/// value, otherwise if [`None`], returns the [default value] for that
@@ -1561,7 +1561,7 @@ impl<T: DerefMut> Option<T> {
/// Converts from `Option<T>` (or `&mut Option<T>`) to `Option<&mut T::Target>`.
///
/// Leaves the original `Option` in-place, creating a new one containing a mutable reference to
/// the inner type's `Deref::Target` type.
/// the inner type's [`Deref::Target`] type.
///
/// # Examples
///
@@ -1701,7 +1701,7 @@ fn into_iter(self) -> IterMut<'a, T> {
#[stable(since = "1.12.0", feature = "option_from")]
impl<T> From<T> for Option<T> {
/// Copies `val` into a new `Some`.
/// Moves `val` into a new [`Some`].
///
/// # Examples
///
@@ -1942,8 +1942,8 @@ unsafe impl<A> TrustedLen for IntoIter<A> {}
impl<A, V: FromIterator<A>> FromIterator<Option<A>> for Option<V> {
/// Takes each element in the [`Iterator`]: if it is [`None`][Option::None],
/// no further elements are taken, and the [`None`][Option::None] is
/// returned. Should no [`None`][Option::None] occur, a container with the
/// values of each [`Option`] is returned.
/// returned. Should no [`None`][Option::None] occur, a container of type
/// `V` containing the values of each [`Option`] is returned.
///
/// # Examples
///
@@ -2039,7 +2039,7 @@ fn from_residual(residual: Option<convert::Infallible>) -> Self {
}
impl<T> Option<Option<T>> {
/// Converts from `Option<Option<T>>` to `Option<T>`
/// Converts from `Option<Option<T>>` to `Option<T>`.
///
/// # Examples
///