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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
//! Different ways to butcher a field. //! //! This module defines the behaviour of each butchering method, and how they //! interact with the butcher derive macro. //! //! This module contains multiple butchering methods, represented by structs. //! These butchering methods implement the [`ButcheringMethod`] trait. //! This trait gives a definition of how the output data must be generated //! based on the input (what output type, what to do when input is borrowed and //! what to do when input is owned). //! //! The [`ButcherField`] trait is implemented for every structure associated to //! a field of struct or enum on which `Butcher` is derived. //! //! [`ButcheringMethod`]: trait.ButcheringMethod.html //! [`ButcherField`]: trait.ButcherField.html use std::borrow::{Borrow, Cow}; use std::ops::Deref; use crate::Butcher; /// Allow to unify the behavior of the different butchering methods. /// /// `T` is the input type, which can be either owned or borrowed for `'cow`. The /// `from_owned` and `from_borrowed` take either an owned or a borrowed `T`, and /// produce a given output type. pub trait ButcheringMethod<'cow, T> where T: 'cow, { /// The output type. type Output: 'cow; /// Create an output with an owned input. fn from_owned(i: T) -> Self::Output; /// Creates an output with a borrowed input. fn from_borrowed(i: &'cow T) -> Self::Output; /// Creates back the initial input data. /// /// This function will clone `i` if it contains borrowed data. fn unbutcher(i: Self::Output) -> T; } /// The regular method, used by default. /// /// This method will transform a type `T` into a `Cow<T>`. It requires that `T` /// is [`Clone`], but will call it only if `unbutcher` is called on borrowed /// variant. /// /// [`Clone`]: https://doc.rust-lang.org/std/clone/trait.Clone.html pub struct Regular; impl<'cow, T> ButcheringMethod<'cow, T> for Regular where T: Clone + 'cow, { type Output = Cow<'cow, T>; /// Create an `Owned` variant, containing `T`. fn from_owned(i: T) -> Self::Output { Cow::Owned(i) } /// Create a `Borrowed` variant, containing a reference to `T`. fn from_borrowed(i: &'cow T) -> Self::Output { Cow::Borrowed(i) } /// Recreates the original data. /// /// This will move the data if it owned, otherwise it will clone it. fn unbutcher(i: Self::Output) -> T { match i { Cow::Borrowed(b) => b.clone(), Cow::Owned(o) => o, } } } /// The as deref method. /// /// This method will transform a type `T` which implements [`Deref`] into a /// `Cow<<T as Deref>::Target>`. This allows users not to have to deal with /// for instance `Cow<String>`, and instead automatically use `Cow<str>`. /// /// See the trait bounds for a complete list of requirements. /// /// [`Deref`]: https://doc.rust-lang.org/std/ops/trait.Deref.html /// [`ToOwned`]: https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html pub struct AsDeref; impl<'cow, T> ButcheringMethod<'cow, T> for AsDeref where T: Deref + Borrow<<T as Deref>::Target> + 'cow, <T as Deref>::Target: ToOwned + 'cow, T: Into<<<T as Deref>::Target as ToOwned>::Owned>, T: From<<<T as Deref>::Target as ToOwned>::Owned>, { type Output = Cow<'cow, <T as Deref>::Target>; /// Create an `Owned` variant, containing `T`. fn from_owned(i: T) -> Self::Output { Cow::Owned(i.into()) } /// Create a `Borrowed` variant, containing a reference to `T`. fn from_borrowed(i: &'cow T) -> Self::Output { Cow::Borrowed(i) } fn unbutcher(i: Self::Output) -> T { match i { Cow::Owned(o) => T::from(o), Cow::Borrowed(b) => b.to_owned().into(), } } } /// The unbox method. /// /// This method allows to get rid of [`Box`] which is often used in order to /// create recursive types. /// /// It requires `T` to implement [`Clone`]. /// /// [`Box`]: https://doc.rust-lang.org/std/boxed/struct.Box.html /// [`Clone`]: https://doc.rust-lang.org/std/clone/trait.Clone.html pub struct Unbox; impl<'cow, T> ButcheringMethod<'cow, Box<T>> for Unbox where T: Clone + 'cow, { type Output = Cow<'cow, T>; /// Create an `Owned` variant, using the conversion requirements described /// previously. fn from_owned(i: Box<T>) -> Self::Output { Cow::Owned(*i) } /// Create a `Borrowed` variant, using the `Deref` trait. fn from_borrowed(i: &'cow Box<T>) -> Self::Output { Cow::Borrowed(Deref::deref(i)) } fn unbutcher(i: Self::Output) -> Box<T> { match i { Cow::Owned(o) => Box::new(o), Cow::Borrowed(b) => Box::new(b.clone()), } } } /// The copy method. /// /// **Note**: this is not related to the `Copy` trait, but it effectively copies /// some data. /// /// This method does not output any [`Cow`] at all. Instead, it moves or copies /// the data provided as input, using the [`Clone`] trait. /// /// [`Cow`]: https://doc.rust-lang.org/std/borrow/enum.Cow.html /// [`Clone`]: https://doc.rust-lang.org/std/clone/trait.Clone.html pub struct Copy; impl<'cow, T> ButcheringMethod<'cow, T> for Copy where T: Clone + 'cow, { type Output = T; /// Move the data. /// /// This may be reduced to a no-op. fn from_owned(i: T) -> Self::Output { i } /// `Clone` the input data. fn from_borrowed(i: &'cow T) -> Self::Output { i.clone() } fn unbutcher(i: Self::Output) -> T { i } } /// The rebutcher method. /// /// This method will butcher again the type which is marked as such. /// /// # Example /// /// In the following code, we destructure a struct inside another struct: /// /// ```rust /// use butcher::Butcher; /// use std::borrow::Cow; /// /// #[derive(Butcher, Clone)] /// struct Foo { /// #[butcher(rebutcher)] /// bar: Bar, /// } /// #[derive(Butcher, Clone)] /// struct Bar(usize); /// /// let input = Foo { bar: Bar(42) }; /// let input = Cow::Borrowed(&input); /// /// let ButcheredFoo { bar: ButcheredBar(value) } = Foo::butcher(input); /// /// assert_eq!(value, Cow::Owned(42)); /// ``` /// /// It requires the type to implement `Butcher` and to implement [`ToOwned`] /// such that `<T as ToOwned>::Owned = T`. The latter requirement can be /// implemented with the [`Clone`] trait. /// /// [`ToOwned`]: https://doc.rust-lang.org/std/borrow/trait.ToOwned.html /// [`Clone`]: https://doc.rust-lang.org/std/clone/trait.Clone.html pub struct Rebutcher; impl<'cow, T> ButcheringMethod<'cow, T> for Rebutcher where T: Butcher<'cow> + Clone + ToOwned<Owned = T> + 'cow, { type Output = <T as Butcher<'cow>>::Output; fn from_owned(i: T) -> Self::Output { <T as Butcher>::butcher(Cow::Owned(i)) } fn from_borrowed(i: &'cow T) -> Self::Output { <T as Butcher>::butcher(Cow::Borrowed(i)) } fn unbutcher(i: Self::Output) -> T { Butcher::unbutcher(i) } } /// Define the behaviour of a specific field of a struct or enum when it is /// butchered. /// /// Implementors just have to specify a correct butchering method. The rest is /// automatically implemented. pub trait ButcherField<'cow, T> where T: 'cow + Clone, { /// The method which will be used. type Method: ButcheringMethod<'cow, T>; fn from_owned(i: T) -> <Self::Method as ButcheringMethod<'cow, T>>::Output { <Self::Method as ButcheringMethod<'cow, T>>::from_owned(i) } fn from_borrowed(i: &'cow T) -> <Self::Method as ButcheringMethod<'cow, T>>::Output { <Self::Method as ButcheringMethod<'cow, T>>::from_borrowed(i) } fn unbutcher(i: <Self::Method as ButcheringMethod<'cow, T>>::Output) -> T { <Self::Method as ButcheringMethod<'cow, T>>::unbutcher(i) } }