diff options
| author | Donnie Bishop <donnie.a.bishop@gmail.com> | 2017-03-30 16:35:19 -0400 |
|---|---|---|
| committer | Donnie Bishop <donnie.a.bishop@gmail.com> | 2017-03-30 16:35:19 -0400 |
| commit | 5d14ccbc96923607f6ab00810817885ee0939486 (patch) | |
| tree | 617ee93cdb40cf100216e8f59a450a1d99e53d8a /src | |
| parent | 17b4884d3c3d88af7f43d5fca32fd8f48d75669b (diff) | |
Modify EncodeUtf16's description
Diffstat (limited to 'src')
| -rw-r--r-- | src/libcollections/str.rs | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/src/libcollections/str.rs b/src/libcollections/str.rs index 219e818f7d7..aee6861a09f 100644 --- a/src/libcollections/str.rs +++ b/src/libcollections/str.rs @@ -133,9 +133,15 @@ impl<S: Borrow<str>> SliceConcatExt<str> for [S] { } } -/// External iterator for a string's UTF-16 code units. +/// An iterator of [`u16`] over the string encoded as UTF-16. /// -/// For use with the `std::iter` module. +/// [`u16`]: ../../std/primitive.u16.html +/// +/// This struct is created by the [`encode_utf16()`] method on [`str`]. +/// See its documentation for more. +/// +/// [`encode_utf16()`]: ../../std/primitive.str.html#method.encode_utf16 +/// [`str`]: ../../std/primitive.str.html #[derive(Clone)] #[stable(feature = "encode_utf16", since = "1.8.0")] pub struct EncodeUtf16<'a> { |
