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<PathBuf>) -> Result<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) -> Result<Self>

Construct the LocalManifest corresponding to the Path provided.

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

Write changes back to the file

pub fn upgrade(
    &mut self,
    dependency: &Dependency,
    dry_run: bool,
    skip_compatible: bool
) -> Result<()>

Instruct this manifest to upgrade a single dependency. If this manifest does not have that dependency, it does nothing.

pub fn insert_into_table(
    &mut self,
    table_path: &[String],
    dep: &Dependency
) -> Result<()>

Add entry to a Cargo.toml.

pub fn update_table_entry(
    &mut self,
    table_path: &[String],
    dep: &Dependency,
    dry_run: bool
) -> Result<()>

Update an entry in Cargo.toml.

pub fn update_table_named_entry(
    &mut self,
    table_path: &[String],
    dep_key: &str,
    dep: &Dependency,
    dry_run: bool
) -> Result<()>

Update an entry with a specified name in Cargo.toml.

pub fn remove_from_table(&mut self, table: &str, name: &str) -> Result<()>

Remove entry from a Cargo.toml.

Examples

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

  let root = std::path::PathBuf::from("/").canonicalize().unwrap();
  let path = root.join("Cargo.toml");
  let mut manifest = LocalManifest { path, manifest: Manifest { data: toml_edit::Document::new() } };
  let dep = Dependency::new("cargo-edit").set_version("0.1.0");
  let _ = manifest.insert_into_table(&vec!["dependencies".to_owned()], &dep);
  assert!(manifest.remove_from_table("dependencies", &dep.name).is_ok());
  assert!(manifest.remove_from_table("dependencies", &dep.name).is_err());
  assert!(manifest.data["dependencies"].is_none());

pub fn add_deps(&mut self, table: &[String], deps: &[Dependency]) -> Result<()>

Add multiple dependencies to manifest

pub fn find_dep<'a>(
    table: &'a mut Item,
    dep_name: &'a str
) -> Option<(String, &'a Item)>

Find a dependency by name (matching on package name for renamed deps)

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

Allow mutating depedencies, wherever they live

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

Override the manifest’s version

Methods from Deref<Target = Manifest>

pub fn package_name(&self) -> Result<&str>

Get the manifest’s package name

pub fn get_table<'a>(
    &'a mut self,
    table_path: &[String]
) -> Result<&'a mut Item>

Get the specified table from the manifest.

pub fn get_sections(&self) -> Vec<(Vec<String>, Item)>

Get all sections in the manifest that exist and might contain dependencies. The returned items are always Table or InlineTable.

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.