# Struct cargo::util::toml_mut::dependency::Dependency

source ·

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

Expand description

A dependency handled by Cargo.

`None` means the field will be blank in TOML.

## Fields (Non-exhaustive)§

This struct is marked as 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.

§`public: Option<bool>`

Whether the dependency is marked as public.

§`features: Option<IndexSet<String>>`

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

§`default_features: Option<bool>`

Whether default features are enabled.

§`inherited_features: Option<IndexSet<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.

## Implementations§

source§

### impl Dependency

source

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

Create a new dependency with a name.

source

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

Set dependency to a given version.

source

#### pub fn clear_version(self) -> Self

Remove the existing version requirement.

source

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

Set whether the dependency is optional.

source

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

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

source

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

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

source

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

Set the value of default-features for the dependency.

source

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

Set the alias for the dependency.

source

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

Set the value of registry for the dependency.

source

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

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

source

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

Get the dependency source.

source

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

Get version of dependency.

source

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

Get registry of the dependency.

source

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

Get the alias for the dependency (if any).

source

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

Whether default features are activated.

source

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

Get whether the dep is optional.

source

#### pub fn public(&self) -> Option<bool>

Get whether the dep is public.

source

#### pub fn source_id( &self, gctx: &GlobalContext ) -> CargoResult<MaybeWorkspace<SourceId>>

Get the SourceID for this dependency.

source

#### pub fn query( &self, gctx: &GlobalContext ) -> CargoResult<MaybeWorkspace<Dependency>>

Query to find this dependency.

source§

### impl Dependency

source

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

Create a dependency from a TOML table entry.

source

#### 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).

source

#### 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

source

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

Modify existing entry to match this dependency.

## Trait Implementations§

source§

### impl Clone for Dependency

source§

#### fn clone(&self) -> Dependency

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for Dependency

source§

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

Formats the value using the given formatter. Read more
source§

### impl Display for Dependency

source§

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

Formats the value using the given formatter. Read more
source§

### impl<'s> From<&'s Summary> for Dependency

source§

#### fn from(other: &'s Summary) -> Self

Converts to this type from the input type.
source§

### impl From<Summary> for Dependency

source§

#### fn from(other: Summary) -> Self

Converts to this type from the input type.
source§

### impl PartialEq for Dependency

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

### impl Eq for Dependency

source§

### impl StructuralPartialEq for Dependency

## Auto Trait Implementations§

§

### impl Freeze for Dependency

§

### impl RefUnwindSafe for Dependency

§

### impl Send for Dependency

§

### impl Sync for Dependency

§

### impl Unpin for Dependency

§

### impl UnwindSafe for Dependency

## Blanket Implementations§

source§

### impl<T> Any for T
where T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for T
where T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
source§

### impl<T, U> Into<U> for T
where U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

§

### impl<T> Pointable for T

§

#### const ALIGN: usize = _

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source§

### impl<T> ToOwned for T
where T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T> ToString for T
where T: Display + ?Sized,

source§

#### default fn to_string(&self) -> String

Converts the given value to a `String`. Read more
source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 344 bytes