whitaker-common 0.2.6

Internal common utilities for Whitaker lints
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

//! Attribute classification helpers.

/// Describes whether an attribute is written as `#![...]` or `#[...]`.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum AttributeKind {
    /// Inner attributes appear inside an item: `#![...]`.
    Inner,
    /// Outer attributes decorate an item from the outside: `#[...]`.
    Outer,
}

impl AttributeKind {
    /// Returns `true` when the attribute is an inner attribute.
    ///
    /// # Examples
    ///
    /// ```
    /// use whitaker_common::attributes::AttributeKind;
    ///
    /// assert!(AttributeKind::Inner.is_inner());
    /// assert!(!AttributeKind::Outer.is_inner());
    /// ```
    #[must_use]
    pub const fn is_inner(self) -> bool {
        matches!(self, Self::Inner)
    }

    /// Returns `true` when the attribute is an outer attribute.
    ///
    /// # Examples
    ///
    /// ```
    /// use whitaker_common::attributes::AttributeKind;
    ///
    /// assert!(AttributeKind::Outer.is_outer());
    /// assert!(!AttributeKind::Inner.is_outer());
    /// ```
    #[must_use]
    pub const fn is_outer(self) -> bool {
        matches!(self, Self::Outer)
    }
}