cargo-semver-checks 0.50.0

Scan your Rust crate for semver violations.
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

use std::borrow::Cow;

#[allow(unused_variables)] // All default implementations are no-ops.
pub(crate) trait ProgressCallbacks<'a> {
    fn generate_placeholder_project_start(
        &mut self,
        crate_name: &str,
        version: &str,
        is_baseline: bool,
    ) {
    }

    fn generate_placeholder_project_success(
        &mut self,
        crate_name: &str,
        version: &str,
        is_baseline: bool,
    ) {
    }

    fn rustdoc_cache_hit(&mut self, crate_name: &str, version: &str, is_baseline: bool) {}

    fn generate_rustdoc_start(&mut self, crate_name: &str, version: &str, is_baseline: bool) {}

    fn generate_rustdoc_success(&mut self, crate_name: &str, version: &str, is_baseline: bool) {}

    fn rustdoc_cache_populated(&mut self, crate_name: &str, version: &str, is_baseline: bool) {}

    fn parse_rustdoc_start(
        &mut self,
        cached: bool,
        crate_name: &str,
        version: &str,
        is_baseline: bool,
    ) {
    }

    fn parse_rustdoc_success(
        &mut self,
        cached: bool,
        crate_name: &str,
        version: &str,
        is_baseline: bool,
    ) {
    }

    fn non_fatal_error(
        &mut self,
        crate_name: &str,
        version: &str,
        is_baseline: bool,
        error: anyhow::Error,
    ) {
    }
}

pub(crate) struct CallbackHandler<'a> {
    crate_name: &'a str,
    version: Cow<'a, str>,
    is_baseline: bool,
    callbacks: &'a mut dyn ProgressCallbacks<'a>,
}

impl std::fmt::Debug for CallbackHandler<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("CallbackHandler")
            .field("crate_name", &self.crate_name)
            .field("version", &self.version)
            .field("callbacks", &"<dyn Trait>")
            .finish()
    }
}

impl<'a> CallbackHandler<'a> {
    pub(crate) fn new(
        crate_name: &'a str,
        version: impl Into<Cow<'a, str>>,
        is_baseline: bool,
        callbacks: &'a mut dyn ProgressCallbacks<'a>,
    ) -> Self {
        Self {
            crate_name,
            version: version.into(),
            is_baseline,
            callbacks,
        }
    }

    pub(super) fn generate_placeholder_project_start(&mut self) {
        self.callbacks.generate_placeholder_project_start(
            self.crate_name,
            self.version.as_ref(),
            self.is_baseline,
        )
    }

    pub(super) fn generate_placeholder_project_success(&mut self) {
        self.callbacks.generate_placeholder_project_success(
            self.crate_name,
            self.version.as_ref(),
            self.is_baseline,
        )
    }

    pub(super) fn rustdoc_cache_hit(&mut self) {
        self.callbacks
            .rustdoc_cache_hit(self.crate_name, self.version.as_ref(), self.is_baseline)
    }

    pub(super) fn generate_rustdoc_start(&mut self) {
        self.callbacks.generate_rustdoc_start(
            self.crate_name,
            self.version.as_ref(),
            self.is_baseline,
        )
    }

    pub(super) fn generate_rustdoc_success(&mut self) {
        self.callbacks.generate_rustdoc_success(
            self.crate_name,
            self.version.as_ref(),
            self.is_baseline,
        )
    }

    pub(super) fn rustdoc_cache_populated(&mut self) {
        self.callbacks.rustdoc_cache_populated(
            self.crate_name,
            self.version.as_ref(),
            self.is_baseline,
        )
    }

    pub(super) fn parse_rustdoc_start(&mut self, cached: bool) {
        self.callbacks.parse_rustdoc_start(
            cached,
            self.crate_name,
            self.version.as_ref(),
            self.is_baseline,
        )
    }

    pub(super) fn parse_rustdoc_success(&mut self, cached: bool) {
        self.callbacks.parse_rustdoc_success(
            cached,
            self.crate_name,
            self.version.as_ref(),
            self.is_baseline,
        )
    }

    pub(super) fn non_fatal_error(&mut self, error: anyhow::Error) {
        self.callbacks.non_fatal_error(
            self.crate_name,
            self.version.as_ref(),
            self.is_baseline,
            error,
        )
    }
}