update readme & cargo doc

Author: holmofy

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "reqwest-scraper"
-version = "0.2.0"
+version = "0.2.1"
 edition = "2021"
 description = "Web scraping integration with reqwest"
 license-file = "LICENSE"

README.md

@@ -18,7 +18,7 @@ Extends [reqwest](https://github.com/seanmonstar/reqwest) to support multiple we
 * add dependency
     ```toml
     reqwest = { version = "0.12", features = ["json"] }
-    reqwest-scraper="0.2.0"
+    reqwest-scraper="0.2.1"
     ```
 * use ScraperResponse
     ```rust

src/css_selector.rs

@@ -1,3 +1,5 @@
+//!  Select elements in HTML response using CSS selector
+//!
 use crate::error::Result;
 use itertools::Itertools;
 
@@ -46,6 +48,7 @@ impl<'a, T> Selectable<'a, T> {
 }
 
 impl<'a> Selectable<'a, scraper::Html> {
+    /// iterator
     pub fn iter(&self) -> HtmlSelectIterator {
         HtmlSelectIterator {
             select: self.node.select(&self.selector),
@@ -54,6 +57,7 @@ impl<'a> Selectable<'a, scraper::Html> {
 }
 
 impl<'a> Selectable<'a, ElementRef<'a>> {
+    /// iterator
     pub fn iter(&self) -> ElementSelectIterator {
         ElementSelectIterator {
             select: self.node.select(&self.selector),
@@ -81,8 +85,11 @@ impl<'a, 'b> Iterator for ElementSelectIterator<'a, 'b> {
     }
 }
 
+/// Case Sensitivity Match
 pub type CaseSensitivity = scraper::CaseSensitivity;
+/// Html element class attribute
 pub type Classes<'a> = scraper::node::Classes<'a>;
+/// Html element attributes
 pub type Attrs<'a> = scraper::node::Attrs<'a>;
 
 impl<'a> SelectItem<'a> {
@@ -116,6 +123,7 @@ impl<'a> SelectItem<'a> {
         self.element.attr(attr)
     }
 
+    /// Returns the text of this element.
     pub fn text(&self) -> String {
         self.element.text().join(" ")
     }
@@ -137,6 +145,7 @@ impl<'a> SelectItem<'a> {
             .map(|e| SelectItem { element: e })
     }
 
+    /// Use CSS selector to find elements based on the current element
     pub fn find(&self, selector: &str) -> Result<Selectable<'a, ElementRef>> {
         Selectable::wrap(selector, &self.element)
     }

src/error.rs

@@ -1,41 +1,44 @@
+//! Scraping Error
+//! 
 use thiserror::Error;
 
+/// Scraping Error
 #[derive(Error, Debug)]
 pub enum ScraperError {
+    /// JsonPath Error
     #[cfg(feature = "jsonpath")]
     #[error(transparent)]
     JsonPathError(#[from] jsonpath_lib::JsonPathError),
 
+    /// Json Deserialize Error
     #[cfg(feature = "jsonpath")]
     #[error(transparent)]
     JsonDeserializeError(#[from] serde_json::Error),
 
+    /// Css Selector Error
     #[cfg(feature = "css_selector")]
     #[error("css selector error: {0}")]
     CssSelectorError(String),
 
+    /// Html Document Parse Error
     #[cfg(feature = "xpath")]
     #[error(transparent)]
     HtmlParseError(#[from] libxml::parser::XmlParseError),
 
-    // #[cfg(feature = "xpath")]
-    // #[error(transparent)]
-    // XPathParseError(#[from] sxd_xpath::ParserError),
-
-    // #[cfg(feature = "xpath")]
-    // #[error(transparent)]
-    // XPathExecutionError(#[from] sxd_xpath::ExecutionError),
-
+    /// XPath Evaluate Error
     #[cfg(feature = "xpath")]
     #[error("{0}")]
     XPathError(String),
 
+    /// IO Error
     #[error(transparent)]
     IOError(#[from] reqwest::Error),
 
+    /// Http response failed
     #[error("http request error:{0}, body text:{1}")]
     HttpError(u16, String),
 
+    /// Illegal Args Error
     #[error("illegal argument:{0}")]
     IllegalArgsError(String),
 }
@@ -47,4 +50,5 @@ impl<'a> From<scraper::error::SelectorErrorKind<'a>> for ScraperError {
     }
 }
 
+/// Result
 pub type Result<T> = std::result::Result<T, ScraperError>;

src/jsonpath.rs

@@ -1,3 +1,5 @@
+//!  Use JsonPath to select fields in json response
+//! 
 use crate::error::{Result, ScraperError};
 use jsonpath_lib as jsonpath;
 

src/lib.rs

@@ -1,3 +1,7 @@
+#![deny(missing_docs)]
+
+#![doc = include_str!("../README.md")]
+
 #[cfg(feature = "css_selector")]
 pub mod css_selector;
 pub mod error;

src/xpath.rs

@@ -1,3 +1,5 @@
+//!  Evalute the value in HTML response using xpath expression
+//!
 use std::collections::HashSet;
 
 use itertools::Itertools;
@@ -19,6 +21,7 @@ pub struct XPathResult {
 }
 
 impl XHtml {
+    /// Using xpath to extract results from html
     pub fn select(&self, xpath: &str) -> Result<XPathResult> {
         let context = Context::new(&self.doc)
             .map_err(|_| ScraperError::XPathError(format!("xpath parse failed:{}", xpath)))?;