Skip to content

Commit cdfe308

Browse files
Fix documentation of as_(mut_)view
1 parent 0010f40 commit cdfe308

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

src/vec.rs

+20-9
Original file line numberDiff line numberDiff line change
@@ -931,29 +931,40 @@ impl<T, const N: usize> Vec<T, N> {
931931
new
932932
}
933933

934-
/// Get a reference to the Vec, erasing the `N` const-generic
934+
/// Get a reference to the `Vec`, erasing the `N` const-generic.
935935
///
936-
/// This can also be used through type coerction, since `Vec<T, N>` implements `Unsize<VecView<T>>`:
937936
///
938937
/// ```rust
939-
/// use heapless::{Vec, VecView};
938+
/// # use heapless::{Vec, VecView};
939+
/// let vec: Vec<u8, 10> = Vec::from_slice(&[1, 2, 3, 4]).unwrap();
940+
/// let view: &VecView<u8> = vec.as_view();
941+
/// ```
940942
///
943+
/// It is often preferable to do the same through type coerction, since `Vec<T, N>` implements `Unsize<VecView<T>>`:
944+
///
945+
/// ```rust
946+
/// # use heapless::{Vec, VecView};
941947
/// let vec: Vec<u8, 10> = Vec::from_slice(&[1, 2, 3, 4]).unwrap();
942-
/// let view: &VecView<_> = &vec;
948+
/// let view: &VecView<u8> = &vec;
943949
/// ```
944950
pub const fn as_view(&self) -> &VecView<T> {
945951
self
946952
}
947953

948-
/// Get a `mut` reference to the Vec, erasing the `N` const-generic
949-
///
950-
/// This can also be used through type coerction, since `Vec<T, N>` implements `Unsize<VecView<T>>`:
954+
/// Get a mutable reference to the `Vec`, erasing the `N` const-generic.
951955
///
952956
/// ```rust
953-
/// use heapless::{Vec, VecView};
957+
/// # use heapless::{Vec, VecView};
958+
/// let mut vec: Vec<u8, 10> = Vec::from_slice(&[1, 2, 3, 4]).unwrap();
959+
/// let view: &mut VecView<u8> = vec.as_mut_view();
960+
/// ```
954961
///
962+
/// It is often preferable to do the same through type coerction, since `Vec<T, N>` implements `Unsize<VecView<T>>`:
963+
///
964+
/// ```rust
965+
/// # use heapless::{Vec, VecView};
955966
/// let mut vec: Vec<u8, 10> = Vec::from_slice(&[1, 2, 3, 4]).unwrap();
956-
/// let view: &mut VecView<_> = &mut vec;
967+
/// let view: &mut VecView<u8> = &mut vec;
957968
/// ```
958969
pub fn as_mut_view(&mut self) -> &mut VecView<T> {
959970
self

0 commit comments

Comments
 (0)