Rollup merge of #36519 - Mark-Simulacrum:example-asmut, r=GuillaumeGomez

Add example in AsMut trait documentation

Let me know of any changes I should make.

r? @GuillaumeGomez
This commit is contained in:
Jonathan Turner 2016-09-16 09:29:49 -07:00 committed by GitHub
commit 919cbc0168

View File

@ -92,6 +92,22 @@ pub trait AsRef<T: ?Sized> {
/// [`Option<T>`]: ../../std/option/enum.Option.html
/// [`Result<T, E>`]: ../../std/result/enum.Result.html
///
/// # Examples
///
/// [`Box<T>`] implements `AsMut<T>`:
///
/// [`Box<T>`]: ../../std/boxed/struct.Box.html
///
/// ```
/// fn add_one<T: AsMut<u64>>(num: &mut T) {
/// *num.as_mut() += 1;
/// }
///
/// let mut boxed_num = Box::new(0);
/// add_one(&mut boxed_num);
/// assert_eq!(*boxed_num, 1);
/// ```
///
/// # Generic Impls
///
/// - `AsMut` auto-dereferences if the inner type is a reference or a mutable