cargo-semver-checks 0.43.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

mod error;
mod generate;
mod progress;
mod request;

use trustfall_rustdoc::{VersionedIndex, VersionedRustdocAdapter, VersionedStorage};

pub(crate) use error::{IntoTerminalResult, TerminalError};
pub(crate) use generate::GenerationSettings;
pub(crate) use progress::ProgressCallbacks;
pub(crate) use request::{CacheSettings, CrateDataRequest};

#[derive(Debug)]
pub(crate) struct DataStorage {
    current: VersionedStorage,
    baseline: VersionedStorage,

    // TODO: This is temporary, until we stop supporting formats older than rustdoc v45.
    // v45+ formats carry target triple information embedded inside the rustdoc JSON file.
    pub(crate) target_triple: &'static str,
}

impl DataStorage {
    pub(crate) fn new(
        current: VersionedStorage,
        baseline: VersionedStorage,
        target_triple: &'static str,
    ) -> Self {
        Self {
            current,
            baseline,
            target_triple,
        }
    }

    pub(crate) fn current_crate(&self) -> &VersionedStorage {
        &self.current
    }

    pub(crate) fn baseline_crate(&self) -> &VersionedStorage {
        &self.baseline
    }
}

impl DataStorage {
    pub(crate) fn create_indexes(&self) -> IndexStorage<'_> {
        IndexStorage {
            current_crate: VersionedIndex::from_storage(&self.current, self.target_triple),
            baseline_crate: VersionedIndex::from_storage(&self.baseline, self.target_triple),
        }
    }
}

#[derive(Debug)]
pub(crate) struct IndexStorage<'a> {
    current_crate: VersionedIndex<'a>,
    baseline_crate: VersionedIndex<'a>,
}

impl IndexStorage<'_> {
    pub(crate) fn create_adapter(&self) -> VersionedRustdocAdapter<'_> {
        VersionedRustdocAdapter::new(&self.current_crate, Some(&self.baseline_crate))
            .expect("failed to construct adapter, this is a bug and should never happen")
    }
}