Struct cargo_edit::Dependency

#[non_exhaustive]
pub struct Dependency {
    pub name: String,
    pub optional: Option<bool>,
    pub features: Option<Vec<String>>,
    pub default_features: Option<bool>,
    pub inherited_features: Option<Vec<String>>,
    pub source: Option<Source>,
    pub registry: Option<String>,
    pub rename: Option<String>,
    pub available_features: BTreeMap<String, Vec<String>>,
}

A dependency handled by Cargo

None means the field will be blank in TOML

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the dependency (as it is set in its Cargo.toml and known to crates.io)

optional: Option<bool>

Whether the dependency is opted-in with a feature flag

features: Option<Vec<String>>

List of features to add (or None to keep features unchanged).

default_features: Option<bool>

Whether default features are enabled

inherited_features: Option<Vec<String>>

List of features inherited from a workspace dependency

source: Option<Source>

Where the dependency comes from

registry: Option<String>

Non-default registry

rename: Option<String>

If the dependency is renamed, this is the new name for the dependency as a string. None if it is not renamed.

available_features: BTreeMap<String, Vec<String>>

Features that are exposed by the dependency

Implementations

impl Dependency

pub fn new(name: &str) -> Self

Create a new dependency with a name

pub fn set_source(self, source: impl Into<Source>) -> Self

Set dependency to a given version

pub fn set_available_features( self, available_features: BTreeMap<String, Vec<String>>, ) -> Self

Set the available features of the dependency to a given vec

pub fn set_optional(self, opt: bool) -> Self

Set whether the dependency is optional

pub fn set_features(self, features: Vec<String>) -> Self

Set features as an array of string (does some basic parsing)

pub fn extend_features(self, features: impl IntoIterator<Item = String>) -> Self

Set features as an array of string (does some basic parsing)

pub fn set_default_features(self, default_features: bool) -> Self

Set the value of default-features for the dependency

pub fn set_rename(self, rename: &str) -> Self

Set the alias for the dependency

pub fn set_registry(self, registry: impl Into<String>) -> Self

Set the value of registry for the dependency

pub fn set_inherited_features(self, features: Vec<String>) -> Self

Set features as an array of string (does some basic parsing)

pub fn source(&self) -> Option<&Source>

Get the dependency source

pub fn version(&self) -> Option<&str>

Get version of dependency

pub fn registry(&self) -> Option<&str>

Get registry of the dependency

pub fn rename(&self) -> Option<&str>

Get the alias for the dependency (if any)

pub fn default_features(&self) -> Option<bool>

Whether default features are activated

pub fn optional(&self) -> Option<bool>

Get whether the dep is optional

impl Dependency

pub fn from_toml(crate_root: &Path, key: &str, item: &Item) -> CargoResult<Self>

Create a dependency from a TOML table entry

pub fn toml_key(&self) -> &str

Get the dependency name as defined in the manifest, that is, either the alias (rename field if Some), or the official package name (name field).

pub fn to_toml(&self, crate_root: &Path) -> Item

Convert dependency to TOML

Returns a tuple with the dependency’s name and either the version as a String or the path/git repository as an InlineTable. (If the dependency is set as optional or default-features is set to false, an InlineTable is returned in any case.)

Panic

Panics if the path is relative

pub fn update_toml( &self, crate_root: &Path, key: &mut KeyMut<'_>, item: &mut Item, )

Modify existing entry to match this dependency

Trait Implementations

impl Clone for Dependency

fn clone(&self) -> Dependency

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dependency

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

Formats the value using the given formatter.

impl Display for Dependency

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

Formats the value using the given formatter.

impl Hash for Dependency

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Dependency

fn cmp(&self, other: &Dependency) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Dependency

fn eq(&self, other: &Dependency) -> 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 Dependency

fn partial_cmp(&self, other: &Dependency) -> 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 Eq for Dependency

impl StructuralPartialEq for Dependency