id_effect 3.0.0

//! **Invariant** — `imap` for types that map in both directions with witnesses.

/// Invariant functor: map with encode/decode witnesses.
pub trait Invariant {
  /// Inner type.
  type Inner;
  /// Invariant map with forward `f` and backward witness `g`.
  fn imap<B>(
    self,
    f: impl FnOnce(Self::Inner) -> B,
    g: impl FnOnce(B) -> Self::Inner,
  ) -> Self::Output<B>
  where
    Self: Sized,
  {
    let _ = g;
    self.imap_f(f)
  }
  /// Forward-only invariant map.
  fn imap_f<B>(self, f: impl FnOnce(Self::Inner) -> B) -> Self::Output<B>;
  /// Result type after mapping.
  type Output<B>;
}

/// Plain newtype `imap`.
pub mod newtype {
  /// Apply `imap` to a plain value (discards backward witness at runtime).
  pub fn imap<A, B, F, G>(a: A, f: F, _g: G) -> B
  where
    F: FnOnce(A) -> B,
    G: FnOnce(B) -> A,
  {
    f(a)
  }
}

#[cfg(test)]
mod tests {
  use super::newtype::imap;

  #[test]
  fn imap_converts() {
    let s = imap(42i32, |n| n.to_string(), |s| s.parse().unwrap());
    assert_eq!(s, "42");
  }

  use super::Invariant;

  struct IdentityWrap<A>(A);

  impl<A> Invariant for IdentityWrap<A> {
    type Inner = A;
    type Output<B> = IdentityWrap<B>;

    fn imap_f<B>(self, f: impl FnOnce(A) -> B) -> IdentityWrap<B> {
      IdentityWrap(f(self.0))
    }
  }

  #[test]
  fn imap_f_maps_directly() {
    let mapped = IdentityWrap("x".to_string()).imap_f(|s| s.len());
    assert_eq!(mapped.0, 1);
  }

  #[test]
  fn default_imap_delegates_to_imap_f() {
    let mapped = IdentityWrap(1).imap(|n| n + 1, |n| n - 1);
    assert_eq!(mapped.0, 2);
  }
}