rustsec 0.17.1

Client library for the RustSec security advisory database
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

//! Version requirements
//!
//! The version matching needed by RustSec is slightly different from the
//! logic needed by `semver` due to the handling of prerelease versions.
//!
//! See:
//! - https://github.com/RustSec/cargo-audit/issues/17
//! - https://github.com/RustSec/cargo-audit/issues/30
//! - https://github.com/steveklabnik/semver/issues/172

// Portions adapted from the `semver` crate.
// Copyright (c) 2016 Steve Klabnik

use super::{predicate::Predicate, Version};
use crate::{Error, ErrorKind};
use serde::{de, ser, Deserialize, Serialize};
use std::{convert::TryFrom, fmt, str::FromStr};

/// Version requirements
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct VersionReq {
    predicates: Vec<Predicate>,
}

impl VersionReq {
    /// Parse a version requirement from a string
    pub fn parse(input: &str) -> Result<Self, Error> {
        match semver_parser::range::parse(input) {
            Ok(req) => Self::try_from(req),
            Err(e) => fail!(ErrorKind::Version, "{}", e),
        }
    }

    /// Match the given `Version` against this `VersionReq`
    pub fn matches(&self, version: &Version) -> bool {
        if self.predicates.is_empty() {
            return true;
        }

        self.predicates.iter().all(|p| p.matches(version))
    }
}

impl FromStr for VersionReq {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Error> {
        Self::parse(s)
    }
}

impl fmt::Display for VersionReq {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.predicates.is_empty() {
            write!(fmt, "*")?;
        } else {
            for (i, ref pred) in self.predicates.iter().enumerate() {
                if i == 0 {
                    write!(fmt, "{}", pred)?;
                } else {
                    write!(fmt, ", {}", pred)?;
                }
            }
        }

        Ok(())
    }
}

impl TryFrom<semver_parser::range::VersionReq> for VersionReq {
    type Error = Error;

    fn try_from(other: semver_parser::range::VersionReq) -> Result<VersionReq, Error> {
        let mut predicates = Vec::with_capacity(other.predicates.len());

        for predicate in other.predicates.into_iter() {
            predicates.push(Predicate::try_from(predicate)?);
        }

        Ok(VersionReq { predicates })
    }
}

impl From<semver::VersionReq> for VersionReq {
    fn from(version_req: semver::VersionReq) -> VersionReq {
        Self::parse(&version_req.to_string()).unwrap()
    }
}

impl From<VersionReq> for semver::VersionReq {
    fn from(version_req: VersionReq) -> semver::VersionReq {
        semver::VersionReq::parse(&version_req.to_string()).unwrap()
    }
}

impl Serialize for VersionReq {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: ser::Serializer,
    {
        serializer.collect_str(self)
    }
}

impl<'de> Deserialize<'de> for VersionReq {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: de::Deserializer<'de>,
    {
        struct VersionReqVisitor;

        impl<'de> de::Visitor<'de> for VersionReqVisitor {
            type Value = VersionReq;

            fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
                formatter.write_str("a SemVer version requirement as a string")
            }

            fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
            where
                E: de::Error,
            {
                VersionReq::parse(v).map_err(de::Error::custom)
            }
        }

        deserializer.deserialize_str(VersionReqVisitor)
    }
}