Add example of delegating associated functions

Kobzol · Jul 7, 2024 · eb03baf · eb03baf
1 parent 556adea
commit eb03baf
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -347,6 +347,30 @@ impl<T> Stack<T> {
   }
   ```
 
+- Delegate associated functions
+  ```rust
+  use delegate::delegate;
+
+  struct A {}
+  impl A {
+      fn foo(a: u32) -> u32 {
+          a + 1
+      }
+  }
+
+  struct B;
+
+  impl B {
+      delegate! {
+          to A {
+              fn foo(a: u32) -> u32;
+          }
+      }
+  }
+
+  assert_eq!(B::foo(1), 2);
+  ```
+
 ## License
 
 Licensed under either of

diff --git a/src/lib.rs b/src/lib.rs
@@ -301,6 +301,29 @@
 //!     }
 //! }
 //! ```
+//! - Delegate associated functions
+//!   ```rust
+//!   use delegate::delegate;
+//!
+//!   struct A {}
+//!   impl A {
+//!       fn foo(a: u32) -> u32 {
+//!           a + 1
+//!       }
+//!   }
+//!
+//!   struct B;
+//!
+//!   impl B {
+//!       delegate! {
+//!           to A {
+//!               fn foo(a: u32) -> u32;
+//!           }
+//!       }
+//!   }
+//!
+//!   assert_eq!(B::foo(1), 2);
+//!   ```
 
 extern crate proc_macro;
 use std::mem;