Skip to main content

TreeBuilder

Struct TreeBuilder 

Source
pub struct TreeBuilder { /* private fields */ }
Expand description

Builds a single tree level: deduplicates entries by name and emits them in Git’s canonical order so the written object is byte-identical to Git’s.

Start from TreeBuilder::new (empty) or TreeBuilder::from_tree (edit an existing level), upsert entries, then build / write.

Implementations§

Source§

impl TreeBuilder

Source

pub fn new() -> Self

Source

pub fn from_tree(tree: Tree) -> Self

Seed the builder with an existing tree level’s entries.

Source

pub fn upsert( &mut self, name: impl Into<BString>, kind: EntryKind, oid: ObjectId, )

Insert or replace the entry named name with one of Git’s canonical kinds.

Source

pub fn upsert_raw(&mut self, name: impl Into<BString>, mode: u32, oid: ObjectId)

Insert or replace using a raw mode (for round-tripping non-canonical modes); prefer upsert for normal entries.

Source

pub fn remove(&mut self, name: &[u8]) -> bool

Remove the entry named name, returning whether one was present.

Source

pub fn is_empty(&self) -> bool

Source

pub fn len(&self) -> usize

Source

pub fn build(self) -> Tree

Collect into a Tree with entries in Git’s canonical order.

Source

pub fn write(self) -> Vec<u8>

The canonical serialized tree body.

Source

pub fn object_id(self, format: ObjectFormat) -> Result<ObjectId>

The OID this tree will have once written.

Trait Implementations§

Source§

impl Clone for TreeBuilder

Source§

fn clone(&self) -> TreeBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TreeBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TreeBuilder

Source§

fn default() -> TreeBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.