feat: macro ArgumentType

frender-rs · May 10, 2023 · 995ac66 · 995ac66
1 parent 8f79c40
commit 995ac66
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/src/argument.rs b/src/argument.rs
@@ -28,8 +28,11 @@ pub trait ProvideArgument {
     ) -> Out;
 }
 
+/// Don't try to remember the name, use [`ArgumentType`](crate::ArgumentType) instead.
 pub struct Value<T>(PhantomData<T>, Invalid);
+/// Don't try to remember the name, use [`ArgumentType`](crate::ArgumentType) instead.
 pub struct ByRef<T: ?Sized>(PhantomData<T>, Invalid);
+/// Don't try to remember the name, use [`ArgumentType`](crate::ArgumentType) instead.
 pub struct ByMut<T: ?Sized>(PhantomData<T>, Invalid);
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]

diff --git a/src/lib.rs b/src/lib.rs
@@ -36,6 +36,22 @@ mod imp;
 
 pub use imp::*;
 
+/// ```
+/// # use callable::{ArgumentType, ArgumentTypes};
+/// # fn __(v:
+/// (ArgumentType![u8], ArgumentType![&str], ArgumentType![&mut Vec<u8>])
+/// # ) ->
+/// // is exactly the same as
+/// ArgumentTypes!(u8, &str, &mut Vec<u8>)
+/// # { v }
+/// ```
+#[macro_export]
+macro_rules! ArgumentType {
+    (&mut $t:ty) => { $crate::argument::ByMut<$t> };
+    (&    $t:ty) => { $crate::argument::ByRef<$t> };
+    (     $t:ty) => { $crate::argument::Value<$t> };
+}
+
 #[macro_export]
 macro_rules! ArgumentTypes {
     () => {