macroific_core 3.0.1

Shared functionality for macroific & macroific_macro
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

//! Extension traits

use proc_macro2::{Ident, Punct, Spacing, Span};
use sealed::sealed;
use std::fmt::Display;
use syn::Error;

/// [`Ident`] extensions
#[sealed]
pub trait MacroificCoreIdentExt {
    /// Shorthand for `Ident::new(name, Span::call_site())`.
    ///
    /// # Example
    ///
    /// ```
    /// # use macroific_core::core_ext::*;
    /// # use proc_macro2::{Ident, Span};
    /// #
    /// let a = Ident::create("foo");
    /// let b = Ident::new("foo", Span::call_site());
    ///
    /// assert_eq!(a, b);
    /// ```
    fn create(name: &str) -> Self;
}

/// [`Punct`] extensions
#[sealed]
pub trait MacroificCorePunctExt {
    /// Create a new [`Punct`] with [`Spacing::Alone`].
    ///
    /// # Example
    ///
    /// ```
    /// # use macroific_core::core_ext::*;
    /// # use proc_macro2::{Punct, Spacing};
    /// #
    /// let p = Punct::new_alone('&');
    /// assert_eq!(p.spacing(), Spacing::Alone);
    /// assert_eq!(p.as_char(), '&');
    /// ```
    fn new_alone(ch: char) -> Self;

    /// Create a new [`Punct`] with [`Spacing::Joint`].
    ///
    /// # Example
    ///
    /// ```
    /// # use macroific_core::core_ext::*;
    /// # use proc_macro2::{Punct, Spacing};
    /// #
    /// let p = Punct::new_joint('^');
    /// assert_eq!(p.spacing(), Spacing::Joint);
    /// assert_eq!(p.as_char(), '^');
    /// ```
    fn new_joint(ch: char) -> Self;
}

/// [`Error`] extensions
#[sealed]
pub trait MacroificCoreErrorExt {
    /// Shorthand for [`Error::new(Span::call_site(), msg)`](Error::new).
    ///
    /// # Example
    ///
    /// ```
    /// # use macroific_core::core_ext::*;
    /// # use proc_macro2::Span;
    /// use syn::Error;
    ///
    /// let e1 = Error::call_site("msg").to_string();
    /// let e2 = Error::new(Span::call_site(), "msg").to_string();
    /// assert_eq!(e1, e2);
    /// ```
    fn call_site<T: Display>(msg: T) -> Self;
}

#[sealed]
impl MacroificCorePunctExt for Punct {
    #[inline]
    fn new_alone(ch: char) -> Self {
        Self::new(ch, Spacing::Alone)
    }

    #[inline]
    fn new_joint(ch: char) -> Self {
        Self::new(ch, Spacing::Joint)
    }
}

#[sealed]
impl MacroificCoreIdentExt for Ident {
    #[inline]
    fn create(name: &str) -> Self {
        Self::new(name, Span::call_site())
    }
}

#[sealed]
impl MacroificCoreErrorExt for Error {
    fn call_site<T: Display>(msg: T) -> Self {
        Self::new(Span::call_site(), msg)
    }
}