Struct cargo_edit::LocalManifest

pub struct LocalManifest {
    pub path: PathBuf,
    pub manifest: Manifest,
}

A Cargo manifest that is available locally.

Fields

path: PathBuf

Path to the manifest

manifest: Manifest

Manifest contents

Implementations

impl LocalManifest

pub fn find(path: Option<&Path>) -> CargoResult<Self>

Construct a LocalManifest. If no path is provided, make an educated guess as to which one the user means.

pub fn try_new(path: &Path) -> CargoResult<Self>

Construct the LocalManifest corresponding to the Path provided.

pub fn write(&self) -> CargoResult<()>

Write changes back to the file

pub fn remove_from_table( &mut self, table_path: &[String], name: &str ) -> CargoResult<()>

Remove entry from a Cargo.toml.

Examples

  use cargo_edit::{Dependency, LocalManifest, Manifest, RegistrySource};
  use toml_edit;

  let root = std::path::PathBuf::from("/").canonicalize().unwrap();
  let path = root.join("Cargo.toml");
  let manifest: toml_edit::Document = "
  [dependencies]
  cargo-edit = '0.1.0'
  ".parse().unwrap();
  let mut manifest = LocalManifest { path, manifest: Manifest { data: manifest } };
  assert!(manifest.remove_from_table(&["dependencies".to_owned()], "cargo-edit").is_ok());
  assert!(manifest.remove_from_table(&["dependencies".to_owned()], "cargo-edit").is_err());
  assert!(!manifest.data.contains_key("dependencies"));

pub fn get_dependency_tables_mut( &mut self ) -> impl Iterator<Item = &mut dyn TableLike> + '_

Allow mutating depedencies, wherever they live

pub fn get_workspace_dependency_table_mut( &mut self ) -> Option<&mut dyn TableLike>

Iterates mutably over the [workspace.dependencies].

pub fn set_package_version(&mut self, version: &Version)

Override the manifest’s version

pub fn version_is_inherited(&self) -> bool

true if the package inherits the workspace version

pub fn get_workspace_version(&self) -> Option<Version>

Get the current workspace version, if any.

pub fn set_workspace_version(&mut self, version: &Version)

Override the workspace’s version.

pub fn gc_dep(&mut self, dep_key: &str)

Remove references to dep_key if its no longer present

Trait Implementations

impl Debug for LocalManifest

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

Formats the value using the given formatter.

impl Deref for LocalManifest

type Target = Manifest

The resulting type after dereferencing.

fn deref(&self) -> &Manifest

Dereferences the value.

impl DerefMut for LocalManifest

fn deref_mut(&mut self) -> &mut Manifest

Mutably dereferences the value.