Struct git2::build::TreeUpdateBuilder

pub struct TreeUpdateBuilder { /* private fields */ }

A builder struct for git tree updates.

Paths passed to remove and upsert can be multi-component paths, i.e. they may contain slashes.

This is a higher-level tree update facility. There is also TreeBuilder which is lower-level (and operates only on one level of the tree at a time).

Implementations

impl TreeUpdateBuilder

pub fn new() -> Self

Create a new empty series of updates.

pub fn remove<T: IntoCString>(&mut self, path: T) -> &mut Self

Add an update removing the specified path from a tree.

pub fn upsert<T: IntoCString>( &mut self, path: T, id: Oid, filemode: FileMode, ) -> &mut Self

Add an update setting the specified path to a specific Oid, whether it currently exists or not.

Note that libgit2 does not support an upsert of a previously removed path, or an upsert that changes the type of an object (such as from tree to blob or vice versa).

pub fn create_updated( &mut self, repo: &Repository, baseline: &Tree<'_>, ) -> Result<Oid, Error>

Create a new tree from the specified baseline and this series of updates.

The baseline tree must exist in the specified repository.

Trait Implementations

impl Default for TreeUpdateBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Send for TreeUpdateBuilder