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
//! # `derive_more` //! Rust has lots of builtin traits that are implemented for its basic types, such as [`Add`], //! [`Not`] or [`From`]. //! However, when wrapping these types inside your own structs or enums you lose the //! implementations of these traits and are required to recreate them. //! This is especially annoying when your own structures are very simple, such as when using the //! commonly advised newtype pattern (e.g. `MyInt(i32)`). //! //! This library tries to remove these annoyances and the corresponding boilerplate code. //! It does this by allowing you to derive lots of commonly used traits for both structs and enums. //! //! ## Example code //! //! By using this library the following code just works: //! //! //! ```rust //! #[macro_use] //! extern crate derive_more; //! //! #[derive(Debug, Eq, PartialEq, From, Add)] //! struct MyInt(i32); //! //! #[derive(Debug, Eq, PartialEq, From, Into, Constructor, Mul)] //! struct Point2D { //! x: i32, //! y: i32, //! } //! //! #[derive(Debug, Eq, PartialEq, From, Add)] //! enum MyEnum { //! Int(i32), //! UnsignedInt(u32), //! Nothing, //! } //! //! fn main() { //! let my_11 = MyInt(5) + 6.into(); //! assert_eq!(MyInt(11), MyInt(5) + 6.into()); //! assert_eq!(Point2D { x: 5, y: 6 } * 10, (50, 60).into()); //! assert_eq!((5, 6), Point2D { x: 5, y: 6 }.into()); //! assert_eq!(Point2D { x: 5, y: 6 }, Point2D::new(5, 6)); //! assert_eq!(MyEnum::Int(15), (MyEnum::Int(8) + 7.into()).unwrap()) //! } //! ``` //! //! ## The derivable traits //! //! Below are all the traits that you can derive using this library. //! Some trait derivations are so similar that the further documentation will only show a single one //! of them. //! You can recognize these by the "-like" suffix in their name. //! The trait name before that will be the only one that is used throughout the further //! documentation. //! //! **NOTE**: You still have to derive each trait separately. So `#[derive(Mul)]` doesn't //! automatically derive `Div` as well. To derive both you should do `#[derive(Mul, Div)]` //! //! ### Conversion traits //! These are traits that are used to convert automatically between types. //! //! 1. [`From`] //! 2. [`Into`] //! 3. [`FromStr`] //! 4. [`TryInto`] (nightly-only as of writing) //! //! ### Formatting traits //! These traits are used for converting a struct to a string in different ways. //! //! 1. `Display`-like, contains [`Display`], [`Binary`], [`Octal`], [`LowerHex`], [`UpperHex`], //! [`LowerExp`], [`UpperExp`], [`Pointer`] //! //! ### Operators //! These are traits that can be used for operator overloading. //! //! 1. [`Index`] //! 2. [`Deref`] //! 3. `Not`-like, contains [`Not`] and [`Neg`] //! 4. `Add`-like, contains [`Add`], [`Sub`], [`BitAnd`], [`BitOr`] and [`BitXor`] //! 5. `Mul`-like, contains [`Mul`], [`Div`], [`Rem`], [`Shr`] and [`Shl`] //! 6. [`IndexMut`] //! 7. [`DerefMut`] //! 8. `AddAssign`-like, contains [`AddAssign`], [`SubAssign`], [`BitAndAssign`], [`BitOrAssign`] //! and [`BitXorAssign`] //! 9. `MulAssign`-like, contains [`MulAssign`], [`DivAssign`], [`RemAssign`], [`ShrAssign`] and //! [`ShlAssign`] //! //! ### Static methods //! These don't derive traits, but derive static methods instead. //! //! 1. `Constructor`, this derives a `new` method that can be used as a constructor. This is very //! basic if you need more customization for your constructor, check out the [`derive-new`] crate. //! //! //! ## Generated code //! //! It is important to understand what code gets generated when using one of the derives from this //! crate. //! That is why the links below explain what code gets generated for a trait for each group from //! before. //! //! 1. [`#[derive(From)]`](from.html) //! 2. [`#[derive(Into)]`](into.html) //! 3. [`#[derive(FromStr)]`](from_str.html) //! 4. [`#[derive(TryInto)]`](try_into.html) //! 5. [`#[derive(Display)]`](display.html) //! 6. [`#[derive(Index)]`](index_op.html) //! 7. [`#[derive(Deref)]`](deref.html) //! 8. [`#[derive(Not)]`](not.html) //! 9. [`#[derive(Add)]`](add.html) //! 10. [`#[derive(Mul)]`](mul.html) //! 11. [`#[derive(IndexMut)]`](index_mut.html) //! 12. [`#[derive(DerefMut)]`](deref_mut.html) //! 13. [`#[derive(AddAssign)]`](add_assign.html) //! 14. [`#[derive(MulAssign)]`](mul_assign.html) //! 15. [`#[derive(Constructor)]`](constructor.html) //! //! If you want to be sure what code is generated for your specific type I recommend using the //! [`cargo-expand`] utility. //! This will show you your code with all macros and derives expanded. //! //! ## Installation //! //! This library requires Rust 1.15 or higher, so this needs to be installed. //! Then add the following to `Cargo.toml`: //! //! ```toml //! [dependencies] //! derive_more = "0.10.0" //! ``` //! //! And this to the top of your Rust file: //! //! ```rust //! #[macro_use] //! extern crate derive_more; //! # fn main () {} //! ``` //! //! [`cargo-expand`]: https://github.com/dtolnay/cargo-expand //! [`derive-new`]: https://github.com/nrc/derive-new //! [`From`]: https://doc.rust-lang.org/core/convert/trait.From.html //! [`Into`]: https://doc.rust-lang.org/core/convert/trait.Into.html //! [`FromStr`]: https://doc.rust-lang.org/std/str/trait.FromStr.html //! [`TryInto`]: https://doc.rust-lang.org/core/convert/trait.TryInto.html //! [`Display`]: https://doc.rust-lang.org/std/fmt/trait.Display.html //! [`Binary`]: https://doc.rust-lang.org/std/fmt/trait.Binary.html //! [`Octal`]: https://doc.rust-lang.org/std/fmt/trait.Octal.html //! [`LowerHex`]: https://doc.rust-lang.org/std/fmt/trait.LowerHex.html //! [`UpperHex`]: https://doc.rust-lang.org/std/fmt/trait.UpperHex.html //! [`LowerExp`]: https://doc.rust-lang.org/std/fmt/trait.LowerExp.html //! [`UpperExp`]: https://doc.rust-lang.org/std/fmt/trait.UpperExp.html //! [`Pointer`]: https://doc.rust-lang.org/std/fmt/trait.Pointer.html //! [`Index`]: https://doc.rust-lang.org/std/ops/trait.Index.html //! [`Deref`]: https://doc.rust-lang.org/std/ops/trait.Deref.html //! [`Not`]: https://doc.rust-lang.org/std/ops/trait.Not.html //! [`Neg`]: https://doc.rust-lang.org/std/ops/trait.Neg.html //! [`Add`]: https://doc.rust-lang.org/std/ops/trait.Add.html //! [`Sub`]: https://doc.rust-lang.org/std/ops/trait.Sub.html //! [`BitAnd`]: https://doc.rust-lang.org/std/ops/trait.BitAnd.html //! [`BitOr`]: https://doc.rust-lang.org/std/ops/trait.BitOr.html //! [`BitXor`]: https://doc.rust-lang.org/std/ops/trait.BitXor.html //! [`Mul`]: https://doc.rust-lang.org/std/ops/trait.Mul.html //! [`Div`]: https://doc.rust-lang.org/std/ops/trait.Div.html //! [`Rem`]: https://doc.rust-lang.org/std/ops/trait.Rem.html //! [`Shr`]: https://doc.rust-lang.org/std/ops/trait.Shr.html //! [`Shl`]: https://doc.rust-lang.org/std/ops/trait.Shl.html //! [`IndexMut`]: https://doc.rust-lang.org/std/ops/trait.IndexMut.html //! [`DerefMut`]: https://doc.rust-lang.org/std/ops/trait.DerefMut.html //! [`AddAssign`]: https://doc.rust-lang.org/std/ops/trait.AddAssign.html //! [`SubAssign`]: https://doc.rust-lang.org/std/ops/trait.SubAssign.html //! [`BitAndAssign`]: https://doc.rust-lang.org/std/ops/trait.BitAndAssign.html //! [`BitOrAssign`]: https://doc.rust-lang.org/std/ops/trait.BitOrAssign.html //! [`BitXorAssign`]: https://doc.rust-lang.org/std/ops/trait.BitXorAssign.html //! [`MulAssign`]: https://doc.rust-lang.org/std/ops/trait.MulAssign.html //! [`DivAssign`]: https://doc.rust-lang.org/std/ops/trait.DivAssign.html //! [`RemAssign`]: https://doc.rust-lang.org/std/ops/trait.RemAssign.html //! [`ShrAssign`]: https://doc.rust-lang.org/std/ops/trait.ShrAssign.html //! [`ShlAssign`]: https://doc.rust-lang.org/std/ops/trait.ShlAssign.html extern crate proc_macro; #[macro_use] extern crate quote; extern crate syn; use proc_macro::TokenStream; mod utils; mod add_assign_like; mod add_like; mod constructor; mod deref; mod deref_mut; mod display; mod from; mod from_str; mod index; mod index_mut; mod into; mod mul_assign_like; mod mul_like; mod not_like; mod try_into; macro_rules! create_derive( ($mod_:ident, $trait_:ident, $fn_name: ident) => { #[proc_macro_derive($trait_)] #[doc(hidden)] pub fn $fn_name(input: TokenStream) -> TokenStream { let ast = syn::parse(input).unwrap(); $mod_::expand(&ast, stringify!($trait_)).into() } } ); create_derive!(from, From, from_derive); create_derive!(into, Into, into_derive); create_derive!(constructor, Constructor, constructor_derive); create_derive!(not_like, Not, not_derive); create_derive!(not_like, Neg, neg_derive); create_derive!(add_like, Add, add_derive); create_derive!(add_like, Sub, sub_derive); create_derive!(add_like, BitAnd, bit_and_derive); create_derive!(add_like, BitOr, bit_or_derive); create_derive!(add_like, BitXor, bit_xor_derive); create_derive!(mul_like, Mul, mul_derive); create_derive!(mul_like, Div, div_derive); create_derive!(mul_like, Rem, rem_derive); create_derive!(mul_like, Shr, shr_derive); create_derive!(mul_like, Shl, shl_derive); create_derive!(add_assign_like, AddAssign, add_assign_derive); create_derive!(add_assign_like, SubAssign, sub_assign_derive); create_derive!(add_assign_like, BitAndAssign, bit_and_assign_derive); create_derive!(add_assign_like, BitOrAssign, bit_or_assign_derive); create_derive!(add_assign_like, BitXorAssign, bit_xor_assign_derive); create_derive!(mul_assign_like, MulAssign, mul_assign_derive); create_derive!(mul_assign_like, DivAssign, div_assign_derive); create_derive!(mul_assign_like, RemAssign, rem_assign_derive); create_derive!(mul_assign_like, ShrAssign, shr_assign_derive); create_derive!(mul_assign_like, ShlAssign, shl_assign_derive); create_derive!(from_str, FromStr, from_str_derive); create_derive!(display, Display, display_derive); create_derive!(display, Binary, binary_derive); create_derive!(display, Octal, octal_derive); create_derive!(display, LowerHex, lower_hex_derive); create_derive!(display, UpperHex, upper_hex_derive); create_derive!(display, LowerExp, lower_exp_derive); create_derive!(display, UpperExp, upper_exp_derive); create_derive!(display, Pointer, pointer_derive); create_derive!(index, Index, index_derive); create_derive!(index_mut, IndexMut, index_mut_derive); create_derive!(try_into, TryInto, try_into_derive); create_derive!(deref, Deref, deref_derive); create_derive!(deref_mut, DerefMut, deref_mut_derive);