release/v0.1.21をmainブランチにマージ

Cargo.toml

@@ -8,7 +8,7 @@ members = [
 resolver = "2"
 
 [workspace.package]
-version = "0.1.20"
+version = "0.1.21"
 edition = "2021"
 description = "A Rust Library to parse japanese addresses."
 repository = "https://github.com/YuukiToriyama/japanese-address-parser"

core/src/domain/common/latlng.rs

@@ -2,6 +2,6 @@
 pub struct LatLng {
     /// 緯度
     pub(crate) latitude: f64,
-    /// 軽度
+    /// 経度
     pub(crate) longitude: f64,
 }

core/src/experimental/parser.rs

@@ -70,9 +70,9 @@ pub struct Parser {
 }
 
 impl Parser {
-    /// Parse address into token sequence.
+    /// Parse address into [ParsedAddress].
     ///
-    /// 住所をパースしトークン列に変換します。
+    /// 住所をパースし、[ParsedAddress]を返します。
     ///
     /// # Example
     /// ```
@@ -81,7 +81,11 @@ impl Parser {
     /// async fn example() {
     ///     let parser = Parser::default();
     ///     let result = parser.parse("埼玉県所沢市上山口2135").await;
-    ///     println!("{:?}", result);
+    ///     assert_eq!(result.prefecture, "埼玉県");
+    ///     assert_eq!(result.city, "所沢市");
+    ///     assert_eq!(result.town, "上山口");
+    ///     assert_eq!(result.rest, "2135");
+    ///     assert_eq!(result.metadata.depth, 3);
     /// }
     /// ```
     pub async fn parse(&self, address: &str) -> ParsedAddress {
@@ -95,15 +99,15 @@ impl Parser {
 #[derive(Debug, PartialEq, Serialize)]
 pub struct ParsedAddress {
     /// 都道府県名
-    prefecture: String,
+    pub prefecture: String,
     /// 市区町村名
-    city: String,
+    pub city: String,
     /// 町名
-    town: String,
+    pub town: String,
     /// それ以降
-    rest: String,
+    pub rest: String,
     /// メタデータ
-    metadata: Metadata,
+    pub metadata: Metadata,
 }
 
 #[derive(Debug, PartialEq, Serialize)]
@@ -112,19 +116,19 @@ pub struct Metadata {
     ///
     /// 住所のパースに成功し、緯度経度の情報が取得できる場合、緯度を返します。
     /// 緯度経度の情報はあくまで検出できた地域の代表点を表すものであり、入力された住所の実際の位置とは必ずしも一致しないことに注意してください。
-    latitude: Option<f64>,
-    /// 軽度
+    pub latitude: Option<f64>,
+    /// 経度
     ///
-    /// 住所のパースに成功し、緯度経度の情報が取得できる場合、軽度を返します。
+    /// 住所のパースに成功し、緯度経度の情報が取得できる場合、経度を返します。
     /// 緯度経度の情報はあくまで検出できた地域の代表点を表すものであり、入力された住所の実際の位置とは必ずしも一致しないことに注意してください。
-    longitude: Option<f64>,
+    pub longitude: Option<f64>,
     /// パース処理の深度
     ///
     /// - `0`: 何も検出できなかった場合
     /// - `1`: 都道府県名までは検出できた場合
     /// - `2`: 市区町村名までは検出できた場合
     /// - `3`: 町名まで検出できた場合
-    depth: u8,
+    pub depth: u8,
 }
 
 impl From<Vec<Token>> for ParsedAddress {