1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

//! The 'ov' crate provides a collection of traits that allow you to chain off of anything.
//! Each trait has a single method with the same name as the trait (but in snake case).
//!
//! [`Over`](trait.Over.html), [`OverRef`](trait.OverRef.html), and [`OverMut`](trait.OverMut.html)
//! are each of `self`, `&self`, and `&mut self`, and the callback receives that same value.
//! They are implemented for all types.
//!
//! [`OverDeref`](trait.OverDeref.html) and [`OverDerefMut`](trait.OverDerefMut.html) are implemented
//! for types which have `Deref` and `DerefMut` implementations. They both borrow the receiver,
//! and pass a reference of the `Deref::target` to the callback.
//!
//! # Usage
//!
//! You may either wildcard import it, or import specific traits. New items will not be added
//! in semver compatible versions.
//!
//! ```
//! use ov::*;
//! ```
//! or
//! ```
//! use ov::Over;
//! ```
//!
//! # Examples
//!
//! A common use for this is with unary enum or struct constructors. These would otherwise
//! be multiple statements with variables, or nested parenthesis.
//!
//! ```
//! use ov::*;
//! use std::error::Error;
//! use std::io::{Error as IoError, ErrorKind};
//!
//! fn maybe_string() -> Option<String> {
//!     "foo".to_owned().over(Some)
//! }
//! assert_eq!(maybe_string(), Some("foo".to_owned()));
//!
//! // A helper is needed as `.over(Box::new)` always creates a Box<IoError>
//! fn to_err_object(error: impl Error + Send + 'static) -> Box<dyn Error + Send> {
//!     Box::new(error)
//! }
//!
//! fn try_io_thing() -> Result<(), Box<dyn Error + Send>> {
//!     IoError::new(ErrorKind::Other, "oh no!").over(to_err_object).over(Err)
//! }
//! ```
//!
//! The `.over_mut` method can be used to perform some mutations on an arbitrary value,
//! including a field of a struct.
//!
//! ```
//! use ov::*;
//! struct S { field: i32 }
//! let mut s = S { field: 5 };
//!
//! s.field.over_mut(|n| {
//!     // n is &mut i32
//!     *n *= 3;
//!     *n += 1;
//! });
//! assert_eq!(s.field, 16);
//! ```
//!
//! The `over_deref` and `over_deref_mut` methods can be useful if you want to use a function
//! that takes e.g. `&str` and you have a `String`.
//!
//! ```
//! # use ov::*;
//! let s = String::from("Hello, world!");
//! // Note: this would fail if `my_str` were `String` or `&String`
//! let len = s.over_deref(|my_str| str::len(my_str));
//! // Can be shortened to this
//! let len = s.over_deref(str::len);
//! assert_eq!(len, 13);
//! ```
//!
//! Another case for this is extracting the value from a mutable reference. For this, we
//! can use [`std::mem::take`] or [`std::mem::replace`]. In the following example we have
//! to use `replace` because `Command` doesn't impl `Default`.
//!
//! [`std::mem::take`]: https://doc.rust-lang.org/stable/std/mem/fn.take.html
//! [`std::mem::replace`]: https://doc.rust-lang.org/stable/std/mem/fn.replace.html
//!
//! ```
//! # use ov::*;
//! use std::process::Command;
//! fn assert_type<T>(_x: T) {}
//!
//! let command = Command::new("ls")
//!     .arg("-a") // returns &mut Command
//!     .arg("-l") // returns &mut Command
//!     .over(|r| std::mem::replace(r, Command::new(""))); // returns Command
//!
//! assert_type::<Command>(command);
/// ```
use std::ops::Deref;
use std::ops::DerefMut;

/// Transform by value (`self`)
pub trait Over: Sized {
    fn over<F, Ret>(self, f: F) -> Ret
    where
        F: FnOnce(Self) -> Ret,
    {
        f(self)
    }
}

impl<T> Over for T {}

/// Transform by shared reference (`&self`)
pub trait OverRef {
    fn over_ref<F, Ret>(&self, f: F) -> Ret
    where
        F: FnOnce(&Self) -> Ret,
    {
        f(self)
    }
}

impl<T> OverRef for T {}

/// Transform by unique reference (`&mut self`)
pub trait OverMut {
    fn over_mut<F, Ret>(&mut self, f: F) -> Ret
    where
        F: FnOnce(&mut Self) -> Ret,
    {
        f(self)
    }
}

impl<T> OverMut for T {}

/// Transform by deref coercion (`&self |> Deref::deref(self)`)
pub trait OverDeref: Deref {
    fn over_deref<F, Ret>(&self, f: F) -> Ret
    where
        F: FnOnce(&<Self as Deref>::Target) -> Ret;
}

impl<T> OverDeref for T
where
    T: Deref,
{
    fn over_deref<F, Ret>(&self, f: F) -> Ret
    where
        F: FnOnce(&Self::Target) -> Ret,
    {
        f(Deref::deref(self))
    }
}

/// Transform by mutable deref coercion (`&self |> DerefMut::deref_mut(self)`)
pub trait OverDerefMut: DerefMut {
    fn over_deref_mut<F, Ret>(&mut self, f: F) -> Ret
    where
        F: FnOnce(&mut Self::Target) -> Ret;
}

impl<T, DerefTarget> OverDerefMut for T
where
    T: DerefMut,
    T: Deref<Target = DerefTarget>,
{
    fn over_deref_mut<F, Ret>(&mut self, f: F) -> Ret
    where
        F: FnOnce(&mut DerefTarget) -> Ret,
    {
        f(DerefMut::deref_mut(self))
    }
}