Struct cargo::ops::cargo_add::DependencyUI

pub struct DependencyUI {
    dep: Dependency,
    available_version: Option<Version>,
    available_features: BTreeMap<String, Vec<String>>,
}

Track presentation-layer information with the editable representation of a [dependencies] entry (Dependency)

Fields

dep: Dependency

Editable representation of a [depednencies] entry

available_version: Option<Version>

The version of the crate that we pulled available_features from

available_features: BTreeMap<String, Vec<String>>

The widest set of features compatible with Dependencys version requirement

Implementations

impl DependencyUI

fn new(dep: Dependency) -> Self

fn apply_summary(&mut self, summary: &Summary)

fn features(&self) -> (IndexSet<&str>, IndexSet<&str>)

Methods from Deref<Target = Dependency>

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.

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

Get whether the dep is public.

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

Get the SourceID for this dependency.

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

Query to find this dependency.

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<'k>( &self, crate_root: &Path, key: &mut KeyMut<'k>, item: &mut Item, )

Modify existing entry to match this dependency.

Trait Implementations

impl Deref for DependencyUI

type Target = Dependency

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for DependencyUI

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

Formats the value using the given formatter.

impl<'s> From<&'s Summary> for DependencyUI

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

Converts to this type from the input type.

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: 408 bytes