Struct RetrievedDependency 

pub struct RetrievedDependency {

    pub name: String,
    pub version: String,
    pub dependency_type: String,
    pub url: Option<String>,
    pub licenses: Option<Vec<String>>,
    pub validated: bool,
    pub is_valid: bool,
    pub is_ignored: bool,
    pub error: Option<String>,
    pub comment: Option<Comment>,
    pub suggested_licenses: Option<Vec<(String, f32)>>,
    pub is_dev: Option<bool>,
    pub is_optional: Option<bool>,
}

A dependency that has been retrieved from its source. The source can be anything, from a third party API (i.e. npm, pub.dev or crates.io APIs) to the file system. It holds information about licenses, errors while validating…

Fields

name: String

Dependency name.

version: String

Dependency version.

dependency_type: String

Dependency type (npm, dart, rust, go, python…)

url: Option<String>

Url of the dependency if available.

licenses: Option<Vec<String>>

List of licenses of the dependency.

validated: bool

Set to true if the dependency has been validated against the licrc.

is_valid: bool

Indicates if the license is valid for our project or not according to our .licrc configuration file.

is_ignored: bool

Indicates if the dependency has been ignored according to our .licrc configuration file.

error: Option<String>

Contains information about any error that may have happened during the validation process.

comment: Option<Comment>

Comments about the license validation process.

suggested_licenses: Option<Vec<(String, f32)>>

In cases where the retriever makes some sort of estimate about the license, this field will contain the suggested licenses.

is_dev: Option<bool>

Indicates if the dependency is a dev dependency or not. This can be null if we cannot determine it.

is_optional: Option<bool>

Indicates if the dependency is an optional dependency or not. This can be null if we cannot determine it.

Implementations

impl RetrievedDependency

pub fn new( name: String, version: String, dependency_type: String, url: Option<String>, licenses: Option<Vec<String>>, error: Option<String>, comment: Option<Comment>, suggested_licenses: Option<Vec<(String, f32)>>, is_dev: Option<bool>, is_optional: Option<bool>, ) -> Self

Creates a new RetrievedDependency with the given parameters. Note that some properties will be automatically set depending on the other ones. For example, if the licenses parameter is None, the is_valid property will be set to false. Use the default method if you just want to create an instance with all the defaults. This method it’s intended to be used once you have retrieved the dependency from its source (i.e. npm, github, etc).

Trait Implementations

impl Clone for RetrievedDependency

fn clone(&self) -> RetrievedDependency

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RetrievedDependency

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RetrievedDependency

fn default() -> RetrievedDependency

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RetrievedDependency

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RetrievedDependency

fn eq(&self, other: &RetrievedDependency) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RetrievedDependency

fn partial_cmp(&self, other: &RetrievedDependency) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RetrievedDependency

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RetrievedDependency