union-fn 0.2.0

Proc. macro for creating efficient "inline closures".
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

#![no_std]

pub use union_fn_macro::union_fn;

/// Allows `#[union_fn]` types with context to be called as functions.
///
/// # Note
///
/// This trait automatically implemented by `#[union_fn]` expansions.
pub trait Call: UnionFn {
    /// Calls the union function.
    fn call(self) -> <Self as UnionFn>::Output;
}

/// Allows `#[union_fn]` types with context to be called as functions.
///
/// # Note
///
/// This trait automatically implemented by `#[union_fn]` expansions.
pub trait CallWithContext: UnionFn {
    /// The shared execution context.
    type Context;

    /// Calls the union function with the given context.
    fn call(self, ctx: &mut Self::Context) -> <Self as UnionFn>::Output;
}

/// Allows `#[union_fn]` types to convert to their optimized instance.
///
/// # Note
///
/// This trait automatically implemented by `#[union_fn]` expansions.
pub trait IntoOpt {
    /// The call optimized `#[union_fn]` type.
    type Opt;
    /// Type responsible to implement calls for the `#[union_fn]` type.
    type Impls;
    /// Type responsible to delegate optimized calls for the call optimized `#[union_fn]` type.
    type Delegator;

    /// Converts the `#[union_fn]` enum to the call optimized type.
    fn into_opt(self) -> Self::Opt;
}

/// Stores information about a `#[union_fn]` macro expansion.
///
/// This helps to link different generated types together and
/// allow them to work interconnectedly.
///
/// # Note
///
/// This trait automatically implemented by `#[union_fn]` expansions.
pub trait UnionFn {
    /// The common output type of all functions in the union function.
    type Output;
    /// Type responsible to hold call optimized parameters.
    type Args;
}