Struct cargo_edit::LocalManifest

source · [−]

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

Expand description

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

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. Read more

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.

Auto Trait Implementations

impl RefUnwindSafe for LocalManifest

impl Send for LocalManifest

impl Sync for LocalManifest

impl Unpin for LocalManifest

impl UnwindSafe for LocalManifest

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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 = mem::align_of::<T>()

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.