]> git.lizzy.rs Git - rust.git/commitdiff
Add examples for StrVector methods
authorJason Thompson <jason@jthompson.ca>
Thu, 3 Jul 2014 10:02:21 +0000 (06:02 -0400)
committerAlex Crichton <alex@alexcrichton.com>
Thu, 3 Jul 2014 19:54:52 +0000 (12:54 -0700)
- examples for connect and concat
- also fixed extra word in existing docs

src/libcollections/str.rs

index fd8ce11d0b5a4bfdfc0256a830edff57445a8229..ddba4b34e3a2a4e8a5664f54b61d95e08ffeb943 100644 (file)
@@ -160,9 +160,27 @@ pub fn from_chars(chs: &[char]) -> String {
 /// Methods for vectors of strings
 pub trait StrVector {
     /// Concatenate a vector of strings.
+    ///
+    /// # Example
+    ///
+    /// ```rust
+    /// let first = "Restaurant at the End of the".to_string();
+    /// let second = " Universe".to_string();
+    /// let string_vec = vec![first, second];
+    /// assert_eq!(string_vec.concat(), "Restaurant at the End of the Universe".to_string());
+    /// ```
     fn concat(&self) -> String;
 
     /// Concatenate a vector of strings, placing a given separator between each.
+    ///
+    /// # Example
+    ///
+    /// ```rust
+    /// let first = "Roast".to_string();
+    /// let second = "Sirloin Steak".to_string();
+    /// let string_vec = vec![first, second];
+    /// assert_eq!(string_vec.connect(", "), "Roast, Sirloin Steak".to_string());
+    /// ```
     fn connect(&self, sep: &str) -> String;
 }
 
@@ -172,7 +190,7 @@ fn concat(&self) -> String {
             return String::new();
         }
 
-        // `len` calculation may overflow but push_str but will check boundaries
+        // `len` calculation may overflow but push_str will check boundaries
         let len = self.iter().map(|s| s.as_slice().len()).sum();
 
         let mut result = String::with_capacity(len);