A set of helper macros
#[autoimpl]
is a variant of #[derive]
, supporting:
```rust use impl_tools::autoimpl; use std::fmt::Debug;
// Generates: impl<'a, T: Animal + ?Sized> Animal for Box
// Generates: impl
// Generates: impl
fn main() { struct Fish; impl Animal for Fish { fn numberoflegs(&self) -> u32 { 0 } }
let my_fish = Named {
name: "Nemo",
animal: Box::new(Fish),
};
assert_eq!(
format!("{my_fish:?} has {} legs!", my_fish.number_of_legs()),
r#"Named { name: "Nemo", .. } has 0 legs!"#
);
} ```
#[impl_default]
implements std::default::Default
:
```rust use impltools::{impldefault, impl_scope};
enum Tree { Ash, Beech, Birch, Willow }
implscope! { #[impldefault] struct Copse { tree_type: Tree, number: u32 = 7, } } ```
impl_scope!
is a function-like macro used to define a type plus its
implementations. It supports impl Self
syntax:
```rust use impltools::implscope; use std::fmt::Display;
impl_scope! {
/// I don't know why this exists
pub struct NamedThing
// Repeats generic parameters of type
impl Self {
fn format_name(&self) -> String {
format!("{}", self.name)
}
}
// Merges generic parameters of type
impl<O> Self where F: Fn(&str) -> O {
fn invoke(&self) -> O {
(self.func)(&self.format_name())
}
}
} ```
Rust's #[derive]
macro allows downstream crates to add implementations for their own traits
(via a special proc-macro
crate). Want to do the same with #[autoimpl]
and with attributes in
impl_scope!
? You can, but the process is a little different:
impl-tools
crate (which is just a thin wrapper around impl-tools-lib
),
and change the name.impl_tools_lib::autoimpl::ImplTrait
] and/or
[impl_tools_lib::ScopeAttr
].autoimpl
/ impl_scope
attribute definitions to include your implementations.The MSRV is 1.56.0 for no particular reason other than that it is the first to support Edition 2021.
Using a nightly compiler allows improved diagnostics, but otherwise stable Rust is fully supported.
no_std
is not yet supported (see #7).
Both Educe and Derivative
have similar functionality: the ability to implement various traits with more flexibility than
libstd's #[derive]
. They also support more functionality such as tweaking the output of Debug
.
Both have less clean syntax, requiring a minimum of two attributes to do anything, with further
attributes to customise implementations (e.g. to ignore a field).
derive_more isn't exactly an "alternative", simply
supporting #[derive]
for more standard traits. Possible functionality overlap in the future
(though for now #[autoimpl]
doesn't support half the traits supported by #[derive]
).
auto_impl allows implementing a trait for reference types
(&
, &mut
, Box
, Rc
, Arc
) as well as function types.
The COPYRIGHT file includes a list of contributors who claim copyright on this project. This list may be incomplete; new contributors may optionally add themselves to this list.
The impl-tools library is published under the terms of the Apache License, Version 2.0. You may obtain a copy of this licence from the LICENSE file or on the following webpage: https://www.apache.org/licenses/LICENSE-2.0