Improve docs of core::option::IterMut

This commit is contained in:
Irfan Hudda 2017-04-01 22:09:10 +05:30
parent 128a313ee2
commit 029ace4071

View File

@ -933,9 +933,15 @@ fn clone(&self) -> Iter<'a, A> {
}
}
/// An iterator over a mutable reference of the contained item in an [`Option`].
/// An iterator over a mutable reference to the [`Some`] variant of an [`Option`].
///
/// The iterator yields one value if the [`Option`] is a [`Some`] variant, otherwise none.
///
/// This `struct` is created by [`Option::iter_mut`] function.
///
/// [`Option`]: enum.Option.html
/// [`Some`]: enum.Option.html#variant.Some
/// [`Option::iter_mut`]: enum.Option.html#method.iter_mut
#[stable(feature = "rust1", since = "1.0.0")]
#[derive(Debug)]
pub struct IterMut<'a, A: 'a> { inner: Item<&'a mut A> }