From a9b6975c87adde151407ad4eb695f78cf4828f39 Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Mon, 30 Nov 2015 14:36:03 -0500 Subject: [PATCH] Write some docs for ToString Part of #29376 --- src/libcollections/string.rs | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/src/libcollections/string.rs b/src/libcollections/string.rs index 9f09facdaf7..5692d648849 100644 --- a/src/libcollections/string.rs +++ b/src/libcollections/string.rs @@ -1179,10 +1179,28 @@ impl PartialEq for ParseError { #[stable(feature = "str_parse_error", since = "1.5.0")] impl Eq for ParseError {} -/// A generic trait for converting a value to a string +/// A trait for converting a value to a `String`. +/// +/// This trait is automatically implemented for any type which implements the +/// [`Display`] trait. As such, `ToString` shouldn't be implemented directly: +/// [`Display`] should be implemented instead, and you get the `ToString` +/// implementation for free. +/// +/// [`Display`]: ../fmt/trait.Display.html #[stable(feature = "rust1", since = "1.0.0")] pub trait ToString { - /// Converts the value of `self` to an owned string + /// Converts the given value to a `String`. + /// + /// # Examples + /// + /// Basic usage: + /// + /// ``` + /// let i = 5; + /// let five = String::from("5"); + /// + /// assert_eq!(five, i.to_string()); + /// ``` #[stable(feature = "rust1", since = "1.0.0")] fn to_string(&self) -> String; }