Skip to content

Automatically implement traits for common smart pointers

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

auto-impl-rs/auto_impl

Repository files navigation

auto_impl CI Crates.io docs

A proc-macro attribute for automatically implementing a trait for references, some common smart pointers and closures.

Usage

This library requires Rust 1.56.0 or newer. This library doesn't leave any public API in your code.

Add auto_impl to your Cargo.toml and just use it in your crate:

// In Rust 2015 you still need `extern crate auto_impl;` at your crate root
use auto_impl::auto_impl;

Add an auto_impl attribute to traits you want to automatically implement for wrapper types. Here is a small example:

// This will generate two additional impl blocks: one for `&T` and one
// for `Box<T>` where `T: Foo`.
#[auto_impl(&, Box)]
trait Foo {
    fn foo(&self);
}

impl Foo for i32 {
    fn foo(&self) {}
}

fn requires_foo(_: impl Foo) {}


requires_foo(0i32);  // works: through the impl we defined above
requires_foo(&0i32); // works: through the generated impl
requires_foo(Box::new(0i32)); // works: through the generated impl

For more explanations, please see the documentation and for more examples, see the examples folder.

Alternatives

This library implements a fraction of a very broad and complex usecase. It's mostly useful for applications that define traits for components, and want to be able to abstract over the storage for those traits. If it doesn't offer some functionality you need, check out the impl-tools project.


License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

Automatically implement traits for common smart pointers

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

No packages published

Languages