dylint 3.2.1

A tool for running Rust lints from dynamic libraries
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192

//! Warning: Addition of public fields to the structs in this module is considered a non-breaking
//! change.
//!
//! For this reason, we recommend using [struct update syntax] when initializing instances of the
//! structs in this module.
//!
//! Example:
//!
//! ```
//! # use crate::dylint::opts::Dylint;
//! let opts = Dylint {
//!     quiet: true,
//!     ..Default::default()
//! };
//! ```
//!
//! [struct update syntax]: https://doc.rust-lang.org/book/ch05-01-defining-structs.html#creating-instances-from-other-instances-with-struct-update-syntax

#[cfg(feature = "package_options")]
use once_cell::sync::Lazy;

#[allow(clippy::struct_excessive_bools)]
#[derive(Clone, Debug, Default)]
pub struct Dylint {
    pub pipe_stderr: Option<String>,

    pub pipe_stdout: Option<String>,

    pub quiet: bool,

    pub operation: Operation,
}

#[derive(Clone, Debug, Default)]
pub struct LibrarySelection {
    pub all: bool,

    pub branch: Option<String>,

    pub git: Option<String>,

    pub lib_paths: Vec<String>,

    pub libs: Vec<String>,

    pub manifest_path: Option<String>,

    pub no_build: bool,

    pub no_metadata: bool,

    pub paths: Vec<String>,

    pub pattern: Option<String>,

    pub rev: Option<String>,

    pub tag: Option<String>,
}

#[derive(Clone, Debug)]
#[non_exhaustive]
pub enum Operation {
    Check(Check),
    List(List),
    #[cfg(feature = "package_options")]
    New(New),
    #[cfg(feature = "package_options")]
    Upgrade(Upgrade),
}

#[allow(clippy::struct_excessive_bools)]
#[derive(Clone, Debug, Default)]
pub struct Check {
    pub lib_sel: LibrarySelection,

    pub fix: bool,

    pub keep_going: bool,

    pub no_deps: bool,

    pub packages: Vec<String>,

    pub workspace: bool,

    pub args: Vec<String>,
}

#[derive(Clone, Debug, Default)]
pub struct List {
    pub lib_sel: LibrarySelection,
}

#[cfg(feature = "package_options")]
#[derive(Clone, Debug, Default)]
pub struct New {
    pub isolate: bool,

    pub path: String,
}

#[cfg(feature = "package_options")]
#[derive(Clone, Debug, Default)]
pub struct Upgrade {
    pub allow_downgrade: bool,

    pub rust_version: Option<String>,

    pub path: String,
}

impl Dylint {
    #[must_use]
    pub const fn has_library_selection(&self) -> bool {
        self.operation.has_library_selection()
    }

    #[must_use]
    pub fn library_selection(&self) -> &LibrarySelection {
        self.operation.library_selection()
    }

    pub fn library_selection_mut(&mut self) -> &mut LibrarySelection {
        self.operation.library_selection_mut()
    }

    pub(crate) fn git_or_path(&self) -> bool {
        self.library_selection().git_or_path()
    }
}

impl LibrarySelection {
    pub(crate) fn git_or_path(&self) -> bool {
        self.git.is_some() || !self.paths.is_empty()
    }
}

#[cfg(feature = "package_options")]
static LIBRARY_SELECTION: Lazy<LibrarySelection> = Lazy::new(LibrarySelection::default);

impl Operation {
    const fn has_library_selection(&self) -> bool {
        match self {
            Self::Check(_) | Self::List(_) => true,
            #[cfg(feature = "package_options")]
            Self::New(_) | Self::Upgrade(_) => false,
        }
    }

    fn library_selection(&self) -> &LibrarySelection {
        match self {
            Self::Check(check) => &check.lib_sel,
            Self::List(list) => &list.lib_sel,
            #[cfg(feature = "package_options")]
            Self::New(_) | Self::Upgrade(_) => {
                if cfg!(debug_assertions) {
                    eprintln!(
                        "[{}:{}] {}",
                        file!(),
                        line!(),
                        "`library_selection` called on an `Operation` with no `LibrarySelection` \
                         field"
                    );
                    eprintln!("{}", std::backtrace::Backtrace::force_capture());
                }
                &LIBRARY_SELECTION
            }
        }
    }

    #[allow(clippy::panic)]
    fn library_selection_mut(&mut self) -> &mut LibrarySelection {
        match self {
            Self::Check(check) => &mut check.lib_sel,
            Self::List(list) => &mut list.lib_sel,
            #[cfg(feature = "package_options")]
            Self::New(_) | Self::Upgrade(_) => {
                panic!(
                    "`library_selection_mut` called on an `Operation` with no `LibrarySelection` \
                     field"
                )
            }
        }
    }
}

impl Default for Operation {
    fn default() -> Self {
        Self::Check(Check::default())
    }
}