Add a doctest for the std::string::as_string method.
Change Example to Examples. Add a doctest that better demonstrates the utility of as_string. Update the doctest example to use String instead of &String.
This commit is contained in:
parent
77cd5cc54e
commit
de3fcee2dc
@ -880,6 +880,19 @@ fn deref<'b>(&'b self) -> &'b String {
|
||||
}
|
||||
|
||||
/// Convert a string slice to a wrapper type providing a `&String` reference.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// use std::string::as_string;
|
||||
///
|
||||
/// fn string_consumer(s: String) {
|
||||
/// assert_eq!(s, "foo".to_string());
|
||||
/// }
|
||||
///
|
||||
/// let string = as_string("foo").clone();
|
||||
/// string_consumer(string);
|
||||
/// ```
|
||||
#[experimental]
|
||||
pub fn as_string<'a>(x: &'a str) -> DerefString<'a> {
|
||||
DerefString { x: as_vec(x.as_bytes()) }
|
||||
|
Loading…
Reference in New Issue
Block a user