Add description independent of Read::read_to_string

This commit is contained in:
Camelid
2020-12-30 11:33:06 -08:00
parent 1f9a8a1620
commit 4ee6d1bf54

View File

@@ -945,12 +945,13 @@ pub trait Read {
} }
} }
/// Convenience function for [`Read::read_to_string`]. /// Read all bytes from a [reader][Read] into a new [`String`].
/// ///
/// This avoids having to create a variable first and it provides more type safety /// This is a convenience function for [`Read::read_to_string`]. Using this
/// since you can only get the buffer out if there were no errors. (If you use /// function avoids having to create a variable first and provides more type
/// [`Read::read_to_string`] you have to remember to check whether the read succeeded /// safety since you can only get the buffer out if there were no errors. (If you
/// because otherwise your buffer will be empty.) /// use [`Read::read_to_string`] you have to remember to check whether the read
/// succeeded because otherwise your buffer will be empty.)
/// ///
/// # Examples /// # Examples
/// ///