rustdoc_processor 0.1.0

Compute, cache, index, and query rustdoc JSON documentation
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

use semver::{Comparator, Op, Version, VersionReq};

/// Given an exact semver version, returns a matcher that matches any semver-compatible
/// version.
/// In the end, `cargo` is in charge of resolving the actual version, so we don't need to
/// be too strict here.
///
/// This is a good defense against crates setting a stale `#![doc(html_root_url = "...")]`
/// (e.g. https://github.com/hyperium/http/pull/688).
pub(crate) struct VersionMatcher {
    req: VersionReq,
}

impl VersionMatcher {
    pub fn new(version: &Version) -> VersionMatcher {
        let mut comparator = Comparator {
            op: Op::Caret,
            major: version.major,
            minor: None,
            patch: None,
            pre: Default::default(),
        };
        if version.pre.is_empty() {
            if version.major == 0 {
                comparator.minor = Some(version.minor);
                if version.minor == 0 {
                    comparator.patch = Some(version.patch);
                }
            }
        } else {
            // We don't play loose with pre-releases.
            comparator.minor = Some(version.minor);
            comparator.patch = Some(version.patch);
            comparator.pre = version.pre.clone();
        }
        let req = VersionReq {
            comparators: vec![comparator],
        };

        VersionMatcher { req }
    }

    pub fn matches(&self, version: &Version) -> bool {
        self.req.matches(version)
    }
}