refactor: href method names (#747)

Author: gadomski

crates/core/CHANGELOG.md

@@ -20,6 +20,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Default to snappy compression for geoparquet ([#673](https://github.com/stac-utils/rustac/pull/673))
 - Ensure geoparquet->json provides valid datetime strings (UTC) ([#711](https://github.com/stac-utils/rustac/pull/711)])
+- Some `Href` method names ([#747](https://github.com/stac-utils/rustac/pull/747))
 
 ### Fixed
 

crates/core/src/href.rs

@@ -82,10 +82,11 @@ impl Href {
     /// ```
     /// use stac::Href;
     ///
-    /// let href = Href::from("./a/b.json").absolute(&"/c/d/e.json".into()).unwrap();
+    /// let href = Href::from("./a/b.json").into_absolute(Href::from("/c/d/e.json")).unwrap();
     /// assert_eq!(href, "/c/d/a/b.json");
     /// ```
-    pub fn absolute(&self, base: &Href) -> Result<Href> {
+    pub fn into_absolute(&self, base: impl AsRef<Href>) -> Result<Href> {
+        let base = base.as_ref();
         tracing::debug!("making href={self} absolute with base={base}");
         match base {
             Href::Url(url) => url.join(self.as_str()).map(Href::Url).map_err(Error::from),
@@ -100,10 +101,11 @@ impl Href {
     /// ```
     /// use stac::Href;
     ///
-    /// let href = Href::from("/a/b/c.json").relative(&"/a/d.json".into()).unwrap();
+    /// let href = Href::from("/a/b/c.json").into_relative(Href::from("/a/d.json")).unwrap();
     /// assert_eq!(href, "./b/c.json");
     /// ```
-    pub fn relative(&self, base: &Href) -> Result<Href> {
+    pub fn into_relative(&self, base: impl AsRef<Href>) -> Result<Href> {
+        let base = base.as_ref();
         tracing::debug!("making href={self} relative with base={base}");
         match base {
             Href::Url(base) => match self {
@@ -221,8 +223,13 @@ impl PartialEq<&str> for Href {
     }
 }
 
+impl AsRef<Href> for Href {
+    fn as_ref(&self) -> &Href {
+        self
+    }
+}
+
 fn make_absolute(href: &str, base: &str) -> String {
-    // TODO if we make this interface public, make this an impl Option
     if href.starts_with('/') {
         href.to_string()
     } else {

crates/core/src/link.rs

@@ -671,20 +671,20 @@ impl Link {
     /// # Examples
     ///
     /// ```
-    /// use stac::Link;
+    /// use stac::{Link, Href};
     ///
     /// let mut link = Link::new("./b/item.json", "rel");
-    /// link.make_absolute(&"/a/base/catalog.json".into()).unwrap();
+    /// link.make_absolute(Href::from("/a/base/catalog.json")).unwrap();
     /// assert_eq!(link.href, "/a/base/b/item.json")
     /// ```
-    pub fn make_absolute(&mut self, base: &Href) -> Result<()> {
-        self.href = self.href.absolute(base)?;
+    pub fn make_absolute(&mut self, base: impl AsRef<Href>) -> Result<()> {
+        self.href = self.href.into_absolute(base)?;
         Ok(())
     }
 
     /// Makes this link relative
-    pub fn make_relative(&mut self, base: &Href) -> Result<()> {
-        self.href = self.href.relative(base)?;
+    pub fn make_relative(&mut self, base: impl AsRef<Href>) -> Result<()> {
+        self.href = self.href.into_relative(base)?;
         Ok(())
     }
 }