Просмотр исходного кода

Add doc examples for `url::Url::path_segments`.

Corey Farwell 9 лет назад
Родитель
Сommit
a65b926f92
1 измененных файлов с 20 добавлено и 0 удалено
  1. 20 0
      src/lib.rs

+ 20 - 0
src/lib.rs

@@ -813,6 +813,26 @@ impl Url {
     ///
     ///
     /// When `Some` is returned, the iterator always contains at least one string
     /// When `Some` is returned, the iterator always contains at least one string
     /// (which may be empty).
     /// (which may be empty).
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use url::Url;
+    ///
+    /// let url = Url::parse("https://example.com/foo/bar").unwrap();
+    /// let mut path_segments = url.path_segments().unwrap();
+    /// assert_eq!(path_segments.next(), Some("foo"));
+    /// assert_eq!(path_segments.next(), Some("bar"));
+    /// assert_eq!(path_segments.next(), None);
+    ///
+    /// let url = Url::parse("https://example.com").unwrap();
+    /// let mut path_segments = url.path_segments().unwrap();
+    /// assert_eq!(path_segments.next(), Some(""));
+    /// assert_eq!(path_segments.next(), None);
+    ///
+    /// let url = Url::parse("data:text/plain,HelloWorld").unwrap();
+    /// assert!(url.path_segments().is_none());
+    /// ```
     pub fn path_segments(&self) -> Option<str::Split<char>> {
     pub fn path_segments(&self) -> Option<str::Split<char>> {
         let path = self.path();
         let path = self.path();
         if path.starts_with('/') {
         if path.starts_with('/') {