lombok-macros 2.0.28

A Rust procedural macro collection providing Lombok-like functionality. Automatically generates getters/setters with field-level visibility control, custom Debug implementations with field skipping, and Display trait implementations. Supports structs, enums, generics and lifetimes.
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

/// Represents the type of a function in the context of getter and setter methods.
///
/// # Variants
/// - `Get` - Represents a getter function.
/// - `GetMut` - Represents a mutable getter function.
/// - `Set` - Represents a setter function.
/// - `Debug` - Represents a debug function.
/// - `New` - Represents a constructor function.
/// - `Unknown` - Represents an unknown or unspecified function type.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
pub(crate) enum FuncType {
    /// Represents a getter function.
    Get,
    /// Represents a mutable getter function.
    GetMut,
    /// Represents a setter function.
    Set,
    /// Represents a debug function.
    Debug,
    /// Represents a constructor function.
    New,
    /// Represents an unknown or unspecified function type.
    #[default]
    Unknown,
}

/// Represents the different parameter type strategies for setter methods.
///
/// This enum defines the strategies for determining parameter types
/// and assignment expressions in setter methods.
///
/// # Variants
/// - `Direct` - Uses the field type directly.
/// - `AsRef` - Uses `impl AsRef<T>` trait bound for parameter conversion.
/// - `Into` - Uses `impl Into<T>` trait bound for parameter conversion.
/// - `AsMut` - Uses `impl AsMut<T>` trait bound for parameter conversion.
/// - `Deref` - Uses `impl Deref<T>` trait bound for parameter conversion.
/// - `Custom` - Uses a custom trait bound specified by the user.
#[derive(Clone, Debug)]
pub(crate) enum ParameterType {
    /// Uses the field type directly.
    Direct,
    /// Uses `impl AsRef<T>` trait bound for parameter conversion.
    AsRef,
    /// Uses `impl Into<T>` trait bound for parameter conversion.
    Into,
    /// Uses `impl AsMut<T>` trait bound for parameter conversion.
    AsMut,
    /// Uses `impl Deref<T>` trait bound for parameter conversion.
    Deref,
    /// Uses a custom trait bound specified by the user.
    Custom(String),
}

/// Represents the return type behavior for getter methods.
///
/// This enum defines how getter methods should return values,
/// controlling whether they return references, cloned values.
///
/// # Variants
/// - `Reference` - Returns a reference to the field value (`&T`).
/// - `Clone` - Returns a cloned copy of the field value (`T`).
/// - `Copy` - Returns a copy of the field value for types implementing Copy trait (`self.field`).
/// - `Deref` - Returns a dereferenced value of the field (`*field`), with match control for Option/Result.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub(crate) enum ReturnType {
    /// Returns a reference to the field value (`&T`).
    #[default]
    Reference,
    /// Returns a cloned copy of the field value (`T`).
    Clone,
    /// Returns a copy of the field value for types implementing Copy trait (`self.field`).
    Copy,
    /// Returns a dereferenced value of the field (`*field`), with match control for Option/Result.
    Deref,
}