mockiato-codegen 0.9.6

Internally used by mockiato for code generation. This crate should never be used directly
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

use std::fmt::Debug;

use syn::{AttributeArgs, Ident, Path};

use crate::result::Result;

/// The `#[mockable]` attribute, which is placed on a trait.
#[cfg_attr(feature = "debug-impls", derive(Debug))]
#[derive(Default)]
pub(crate) struct MockableAttr {
    /// Customizes the name of the generated mock struct.
    /// Example usage: `#[name = "FooMock"]`
    pub(crate) name: Option<Ident>,
    /// Enforces that only static lifetimes are used within the mock.
    /// Example usage: `#[mockable(static_references)]`.
    pub(crate) force_static_lifetimes: bool,
    /// Enables mocking of a remote trait.
    /// Example usage: `#[mockable(remote = "io::Write")]`
    pub(crate) remote_trait_path: Option<RemoteTraitPath>,
}

#[cfg_attr(feature = "debug-impls", derive(Debug))]
pub(crate) enum RemoteTraitPath {
    /// Corresponds to the `remote` parameter without a value:  
    /// `#[mockable(remote)]`
    SameAsLocalIdent,
    /// Corresponds to the `remote` parameter with a [`Path`] as value:  
    /// `#[mockable(remote = "std::io::Write")]`
    Path(Path),
}

#[cfg_attr(test, mockiato::mockable)]
pub(crate) trait MockableAttrParser: Debug {
    fn parse(&self, args: AttributeArgs) -> Result<MockableAttr>;
}