Use and recommend NamespaceResolver methods instead of NsReader methods

Author: Mingun

src/events/attributes.rs

@@ -399,7 +399,7 @@ impl<'a> Attributes<'a> {
 
         self.any(|attr| {
             if let Ok(attr) = attr {
-                match reader.resolve_attribute(attr.key) {
+                match reader.resolver().resolve_attribute(attr.key) {
                     (
                         Bound(Namespace(b"http://www.w3.org/2001/XMLSchema-instance")),
                         LocalName(b"nil"),

src/reader/async_tokio.rs

@@ -210,7 +210,7 @@ impl<R: AsyncBufRead + Unpin> NsReader<R> {
     /// given buffer.
     ///
     /// This method manages namespaces but doesn't resolve them automatically.
-    /// You should call [`resolve_element()`] if you want to get a namespace.
+    /// You should call [`resolver().resolve_element()`] if you want to get a namespace.
     ///
     /// You also can use [`read_resolved_event_into_async()`] instead if you want
     /// to resolve namespace as soon as you get an event.
@@ -239,7 +239,7 @@ impl<R: AsyncBufRead + Unpin> NsReader<R> {
     ///     match reader.read_event_into_async(&mut buf).await.unwrap() {
     ///         Event::Start(e) => {
     ///             count += 1;
-    ///             let (ns, local) = reader.resolve_element(e.name());
+    ///             let (ns, local) = reader.resolver().resolve_element(e.name());
     ///             match local.as_ref() {
     ///                 b"tag1" => assert_eq!(ns, Bound(Namespace(b"www.xxxx"))),
     ///                 b"tag2" => assert_eq!(ns, Bound(Namespace(b"www.yyyy"))),
@@ -260,7 +260,7 @@ impl<R: AsyncBufRead + Unpin> NsReader<R> {
     /// ```
     ///
     /// [`read_event_into()`]: NsReader::read_event_into
-    /// [`resolve_element()`]: Self::resolve_element
+    /// [`resolver().resolve_element()`]: crate::name::NamespaceResolver::resolve_element
     /// [`read_resolved_event_into_async()`]: Self::read_resolved_event_into_async
     pub async fn read_event_into_async<'b>(&mut self, buf: &'b mut Vec<u8>) -> Result<Event<'b>> {
         self.pop();

src/reader/ns_reader.rs

@@ -380,7 +380,7 @@ impl<R: BufRead> NsReader<R> {
     /// Reads the next event into given buffer.
     ///
     /// This method manages namespaces but doesn't resolve them automatically.
-    /// You should call [`resolve_element()`] if you want to get a namespace.
+    /// You should call [`resolver().resolve_element()`] if you want to get a namespace.
     ///
     /// You also can use [`read_resolved_event_into()`] instead if you want to resolve
     /// namespace as soon as you get an event.
@@ -408,7 +408,7 @@ impl<R: BufRead> NsReader<R> {
     ///     match reader.read_event_into(&mut buf).unwrap() {
     ///         Event::Start(e) => {
     ///             count += 1;
-    ///             let (ns, local) = reader.resolve_element(e.name());
+    ///             let (ns, local) = reader.resolver().resolve_element(e.name());
     ///             match local.as_ref() {
     ///                 b"tag1" => assert_eq!(ns, Bound(Namespace(b"www.xxxx"))),
     ///                 b"tag2" => assert_eq!(ns, Bound(Namespace(b"www.yyyy"))),
@@ -427,7 +427,7 @@ impl<R: BufRead> NsReader<R> {
     /// assert_eq!(txt, vec!["Test".to_string(), "Test 2".to_string()]);
     /// ```
     ///
-    /// [`resolve_element()`]: Self::resolve_element
+    /// [`resolver().resolve_element()`]: NamespaceResolver::resolve_element
     /// [`read_resolved_event_into()`]: Self::read_resolved_event_into
     #[inline]
     pub fn read_event_into<'b>(&mut self, buf: &'b mut Vec<u8>) -> Result<Event<'b>> {
@@ -622,7 +622,7 @@ impl<'i> NsReader<&'i [u8]> {
     /// Reads the next event, borrow its content from the input buffer.
     ///
     /// This method manages namespaces but doesn't resolve them automatically.
-    /// You should call [`resolve_element()`] if you want to get a namespace.
+    /// You should call [`resolver().resolve_element()`] if you want to get a namespace.
     ///
     /// You also can use [`read_resolved_event()`] instead if you want to resolve namespace
     /// as soon as you get an event.
@@ -653,7 +653,7 @@ impl<'i> NsReader<&'i [u8]> {
     ///     match reader.read_event().unwrap() {
     ///         Event::Start(e) => {
     ///             count += 1;
-    ///             let (ns, local) = reader.resolve_element(e.name());
+    ///             let (ns, local) = reader.resolver().resolve_element(e.name());
     ///             match local.as_ref() {
     ///                 b"tag1" => assert_eq!(ns, Bound(Namespace(b"www.xxxx"))),
     ///                 b"tag2" => assert_eq!(ns, Bound(Namespace(b"www.yyyy"))),
@@ -671,7 +671,7 @@ impl<'i> NsReader<&'i [u8]> {
     /// assert_eq!(txt, vec!["Test".to_string(), "Test 2".to_string()]);
     /// ```
     ///
-    /// [`resolve_element()`]: Self::resolve_element
+    /// [`resolver().resolve_element()`]: NamespaceResolver::resolve_element
     /// [`read_resolved_event()`]: Self::read_resolved_event
     #[inline]
     pub fn read_event(&mut self) -> Result<Event<'i>> {

tests/reader-namespaces.rs

@@ -18,7 +18,7 @@ fn namespace() {
             e
         ),
     }
-    let it1 = r.prefixes();
+    let it1 = r.resolver().bindings();
     let it2 = it1.clone();
     assert_eq!(it1.size_hint(), (0, Some(1)));
     assert_eq!(
@@ -40,7 +40,7 @@ fn namespace() {
             e
         ),
     }
-    let it = r.prefixes();
+    let it = r.resolver().bindings();
     assert_eq!(it.size_hint(), (0, Some(1)));
     assert_eq!(
         it.collect::<Vec<_>>(),
@@ -52,7 +52,7 @@ fn namespace() {
         Ok((ns, Text(_))) => assert_eq!(ns, Unbound),
         e => panic!("expecting text content with no namespace, got {:?}", e),
     }
-    let it = r.prefixes();
+    let it = r.resolver().bindings();
     assert_eq!(it.size_hint(), (0, Some(1)));
     assert_eq!(
         it.collect::<Vec<_>>(),
@@ -67,7 +67,7 @@ fn namespace() {
             e
         ),
     }
-    let it = r.prefixes();
+    let it = r.resolver().bindings();
     assert_eq!(it.size_hint(), (0, Some(1)));
     assert_eq!(
         it.collect::<Vec<_>>(),
@@ -79,7 +79,7 @@ fn namespace() {
         Ok((ns, End(_))) => assert_eq!(ns, Unbound),
         e => panic!("expecting outer end element with no namespace, got {:?}", e),
     }
-    let it = r.prefixes();
+    let it = r.resolver().bindings();
     assert_eq!(it.size_hint(), (0, Some(1)));
     assert_eq!(
         it.collect::<Vec<_>>(),
@@ -109,7 +109,7 @@ mod default_namespace {
             // we don't care about xmlns attributes for this test
             .filter(|kv| kv.key.as_namespace_binding().is_none())
             .map(|Attribute { key: name, value }| {
-                let (opt_ns, local_name) = r.resolve_attribute(name);
+                let (opt_ns, local_name) = r.resolver().resolve_attribute(name);
                 (opt_ns, local_name.into_inner(), value)
             });
         assert_eq!(
@@ -118,7 +118,7 @@ mod default_namespace {
         );
         assert_eq!(attrs.next(), None);
 
-        let it = r.prefixes();
+        let it = r.resolver().bindings();
         assert_eq!(it.size_hint(), (0, Some(1)));
         assert_eq!(
             it.collect::<Vec<_>>(),
@@ -138,7 +138,7 @@ mod default_namespace {
                 e
             ),
         }
-        let it = r.prefixes();
+        let it = r.resolver().bindings();
         assert_eq!(it.size_hint(), (0, Some(0)));
         assert_eq!(it.collect::<Vec<_>>(), vec![]);
 
@@ -150,7 +150,7 @@ mod default_namespace {
                 e
             ),
         }
-        let it = r.prefixes();
+        let it = r.resolver().bindings();
         assert_eq!(it.size_hint(), (0, Some(1)));
         assert_eq!(
             it.collect::<Vec<_>>(),
@@ -165,7 +165,7 @@ mod default_namespace {
                 e
             ),
         }
-        let it = r.prefixes();
+        let it = r.resolver().bindings();
         assert_eq!(it.size_hint(), (0, Some(1)));
         assert_eq!(
             it.collect::<Vec<_>>(),
@@ -178,7 +178,7 @@ mod default_namespace {
             Ok((ns, End(_))) => assert_eq!(ns, Unbound),
             e => panic!("expecting outer end element with no namespace, got {:?}", e),
         }
-        let it = r.prefixes();
+        let it = r.resolver().bindings();
         assert_eq!(it.size_hint(), (0, Some(0)));
         assert_eq!(it.collect::<Vec<_>>(), vec![]);
     }
@@ -195,7 +195,7 @@ mod default_namespace {
                 e
             ),
         }
-        let it = r.prefixes();
+        let it = r.resolver().bindings();
         assert_eq!(it.size_hint(), (0, Some(1)));
         assert_eq!(
             it.collect::<Vec<_>>(),
@@ -210,7 +210,7 @@ mod default_namespace {
                 e
             ),
         }
-        let it = r.prefixes();
+        let it = r.resolver().bindings();
         assert_eq!(it.size_hint(), (0, Some(2)));
         assert_eq!(it.collect::<Vec<_>>(), vec![]);
 
@@ -219,7 +219,7 @@ mod default_namespace {
             Ok((ns, End(_))) => assert_eq!(ns, Unbound),
             e => panic!("expecting inner end element with no namespace, got {:?}", e),
         }
-        let it = r.prefixes();
+        let it = r.resolver().bindings();
         assert_eq!(it.size_hint(), (0, Some(2)));
         assert_eq!(it.collect::<Vec<_>>(), vec![]);
 
@@ -231,7 +231,7 @@ mod default_namespace {
                 e
             ),
         }
-        let it = r.prefixes();
+        let it = r.resolver().bindings();
         assert_eq!(it.size_hint(), (0, Some(1)));
         assert_eq!(
             it.collect::<Vec<_>>(),
@@ -255,7 +255,7 @@ mod default_namespace {
                 e => panic!("Expected Start event (<outer>), got {:?}", e),
             }
 
-            let it = r.prefixes();
+            let it = r.resolver().bindings();
             assert_eq!(it.size_hint(), (0, Some(1)));
             assert_eq!(
                 it.collect::<Vec<_>>(),
@@ -280,7 +280,7 @@ mod default_namespace {
                 // we don't care about xmlns attributes for this test
                 .filter(|kv| kv.key.as_namespace_binding().is_none())
                 .map(|Attribute { key: name, value }| {
-                    let (opt_ns, local_name) = r.resolve_attribute(name);
+                    let (opt_ns, local_name) = r.resolver().resolve_attribute(name);
                     (opt_ns, local_name.into_inner(), value)
                 });
             // the attribute should _not_ have a namespace name. The default namespace does not
@@ -291,7 +291,7 @@ mod default_namespace {
             );
             assert_eq!(attrs.next(), None);
 
-            let it = r.prefixes();
+            let it = r.resolver().bindings();
             assert_eq!(it.size_hint(), (0, Some(2)));
             assert_eq!(
                 it.collect::<Vec<_>>(),
@@ -307,7 +307,7 @@ mod default_namespace {
             }
             e => panic!("Expected End event (<outer>), got {:?}", e),
         }
-        let it = r.prefixes();
+        let it = r.resolver().bindings();
         assert_eq!(it.size_hint(), (0, Some(1)));
         assert_eq!(
             it.collect::<Vec<_>>(),
@@ -349,7 +349,7 @@ mod default_namespace {
                 // we don't care about xmlns attributes for this test
                 .filter(|kv| kv.key.as_namespace_binding().is_none())
                 .map(|Attribute { key: name, value }| {
-                    let (opt_ns, local_name) = r.resolve_attribute(name);
+                    let (opt_ns, local_name) = r.resolver().resolve_attribute(name);
                     (opt_ns, local_name.into_inner(), value)
                 });
             // the attribute should _not_ have a namespace name. The default namespace does not
@@ -400,7 +400,7 @@ fn attributes_empty_ns() {
         // we don't care about xmlns attributes for this test
         .filter(|kv| kv.key.as_namespace_binding().is_none())
         .map(|Attribute { key: name, value }| {
-            let (opt_ns, local_name) = r.resolve_attribute(name);
+            let (opt_ns, local_name) = r.resolver().resolve_attribute(name);
             (opt_ns, local_name.into_inner(), value)
         });
     assert_eq!(
@@ -417,7 +417,7 @@ fn attributes_empty_ns() {
     );
     assert_eq!(attrs.next(), None);
 
-    let it = r.prefixes();
+    let it = r.resolver().bindings();
     assert_eq!(it.size_hint(), (0, Some(1)));
     assert_eq!(
         it.collect::<Vec<_>>(),
@@ -446,7 +446,7 @@ fn attributes_empty_ns_expanded() {
             // we don't care about xmlns attributes for this test
             .filter(|kv| kv.key.as_namespace_binding().is_none())
             .map(|Attribute { key: name, value }| {
-                let (opt_ns, local_name) = r.resolve_attribute(name);
+                let (opt_ns, local_name) = r.resolver().resolve_attribute(name);
                 (opt_ns, local_name.into_inner(), value)
             });
         assert_eq!(
@@ -463,7 +463,7 @@ fn attributes_empty_ns_expanded() {
         );
         assert_eq!(attrs.next(), None);
 
-        let it = r.prefixes();
+        let it = r.resolver().bindings();
         assert_eq!(it.size_hint(), (0, Some(1)));
         assert_eq!(
             it.collect::<Vec<_>>(),