Merge pull request #83 from auto-impl-rs/cargo/1.0.0

Prepare for 1.0.0 release

Author: KodrAus

.github/workflows/ci.yml

@@ -25,7 +25,11 @@ jobs:
     - name: Build
       run: cargo build
     - name: Run tests
-      run: cargo test -- --skip ui_compile_fail
+      if: matrix.rust-version != '1.37'
+      run: cargo test --all -- --skip ui_compile_fail
     - name: Run compile-fail tests
       if: matrix.rust-version == 'stable'
       run: cargo test -- ui_compile_fail
+    - name: Run tests (MSRV)
+      if: matrix.rust-version == '1.37'
+      run: cargo test -- --skip ui_compile_fail

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "auto_impl"
-version = "0.5.0"
+version = "1.0.0"
 authors = [
     "Ashley Mannix <[email protected]>",
     "Lukas Kalbertodt <[email protected]>",
@@ -16,6 +16,10 @@ autotests = true
 edition = "2018"
 rust-version = "1.37"
 
+[workspace]
+members = [
+    "examples/async_await"
+]
 
 [lib]
 proc-macro = true

README.md

@@ -5,7 +5,7 @@ some common smart pointers and closures.
 
 # Usage
 
-This library requires Rust 1.37.0 or newer.
+This library requires Rust 1.37.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:
 

examples/async_await/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "auto_impl_async_await_example"
+version = "0.0.0"
+publish = false
+edition = "2018"
+
+[dependencies]
+auto_impl = { path = "../../" }
+async-trait = "0.1"
+async-std = { version = "1", features = ["attributes"] }

examples/async_await/src/main.rs

@@ -0,0 +1,32 @@
+use std::time::Duration;
+use async_std::task;
+
+use async_trait::async_trait;
+use auto_impl::auto_impl;
+
+// Note the order of the attributes here:
+// `#[async_trait]` must appear first
+#[async_trait]
+#[auto_impl(&, Box, Arc)]
+trait Component {
+    async fn run(&self);
+}
+
+struct WaitABit(Duration);
+
+#[async_trait]
+impl Component for WaitABit {
+    async fn run(&self) {
+        task::sleep(self.0).await;
+    }
+}
+
+async fn run_async(a: impl Component) {
+    a.run().await;
+}
+
+#[async_std::main]
+async fn main() {
+    // We can treat our `Box<WaitABit>` as an `impl Component` directly
+    run_async(Box::new(WaitABit(Duration::from_secs(1)))).await;
+}