Merge branch 'main' into cleanup

Author: asmello

CHANGELOG.md

@@ -7,12 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-### Fixed
-
 ### Deprecated
 
 -   Deprecated `ResolveError` name.
 
+### Changed
+-   Sealed the `Diagnose` trait.
+-   Implementation of the `Default` trait for `Pointer` now doesn't constrain the lifetime.
+
 ## [0.7.1] 2025-02-16
 
 ### Changed

README.md

@@ -136,10 +136,10 @@ use jsonptr::Pointer;
 use serde_json::json;
 
 let ptr = Pointer::parse("/secret/universe").unwrap();
-let mut data = json!({"secret": { "universe": 42 }});
-let replaced = ptr.assign(&mut data, json!(34)).unwrap();
-assert_eq!(replaced, Some(json!(42)));
-assert_eq!(data, json!({"secret": { "universe": 34 }}));
+let mut data = json!({"secret": { "life": 42, "universe": 42, "everything": 42 }});
+let deleted = ptr.delete(&mut data);
+assert_eq!(deleted, Some(json!(42)));
+assert_eq!(data, json!({"secret": { "life": 42, "everything": 42 }}));
 ```
 
 ### Error Reporting

src/diagnostic.rs

@@ -165,7 +165,7 @@ pub(crate) use diagnostic_url;
 /// An extension trait for `Result<_, E>`, where `E` is an implementation of
 /// [`Diagnostic`], that converts `E` into [`Report<E>`](`Report`), yielding
 /// `Result<_, Report<E>>`.
-pub trait Diagnose<'s, T> {
+pub trait Diagnose<'s, T>: private::Sealed {
     /// The error type returned from `diagnose` and `diagnose_with`.
     type Error: Diagnostic;
 
@@ -226,6 +226,11 @@ where
     }
 }
 
+mod private {
+    pub trait Sealed {}
+    impl<T, E> Sealed for Result<T, E> {}
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

src/pointer.rs

@@ -36,7 +36,7 @@ mod slice;
 #[cfg_attr(not(doc), repr(transparent))]
 pub struct Pointer(str);
 
-impl Default for &'static Pointer {
+impl Default for &Pointer {
     fn default() -> Self {
         Pointer::root()
     }
@@ -398,7 +398,7 @@ impl Pointer {
     /// [`Delete`]. The supplied implementations (`"json"` & `"toml"`) operate
     /// as follows:
     /// - If the `Pointer` can be resolved, the `Value` is deleted and returned.
-    /// - If the `Pointer` fails to resolve for any reason, `Ok(None)` is returned.
+    /// - If the `Pointer` fails to resolve for any reason, `None` is returned.
     /// - If the `Pointer` is root, `value` is replaced:
     ///     - `"json"`: `serde_json::Value::Null`
     ///     - `"toml"`: `toml::Value::Table::Default`
@@ -2333,4 +2333,14 @@ mod tests {
         let unboxed = boxed.into_buf();
         assert_eq!(subjectal, unboxed);
     }
+
+    #[test]
+    fn default_lifetime_is_correct() {
+        // if this compiles, we're good
+        fn or_default(ptr: &Pointer) -> &Pointer {
+            Some(ptr).unwrap_or_default()
+        }
+        // just to satisfy codecov and clippy
+        or_default(Pointer::root());
+    }
 }