Skip to main content

TreeEntry

Struct TreeEntry 

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

A single entry inside a Tree.

An entry is the basic building block of a directory listing. It pairs a name with a kind (blob or subtree) and a hash that points to the actual content.

§Validation

The name must be non‑empty and ≤ MAX_NAME_LENGTH.

§Example

use libvctrl_handler::{Hash, TreeEntry, EntryKind};

let hash = Hash::from_bytes(&[0x11; 64]).unwrap();

// A file entry.
let file = TreeEntry::new("src/main.rs".into(), EntryKind::Blob, hash)
    .expect("valid entry");
assert_eq!(file.name(), "src/main.rs");
assert_eq!(file.kind(), EntryKind::Blob);
assert_eq!(file.hash().as_bytes().len(), 64);

// An empty name is rejected.
assert!(TreeEntry::new("".into(), EntryKind::Blob, hash).is_err());

Implementations§

Source§

impl TreeEntry

Source

pub fn new( name: String, kind: EntryKind, hash: Hash, ) -> Result<Self, VctrlError>

Creates a new TreeEntry after validating the name.

§Errors

Returns VctrlError::InvalidName if name is empty or too long.

Source

pub fn name(&self) -> &str

Returns the name of the entry.

Source

pub const fn kind(&self) -> EntryKind

Returns the kind of the entry (blob or tree).

Source

pub const fn hash(&self) -> &Hash

Returns the hash of the entry (points to a Blob or another Tree).

Trait Implementations§

Source§

impl Clone for TreeEntry

Source§

fn clone(&self) -> TreeEntry

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 TreeEntry

Source§

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

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

impl Eq for TreeEntry

Source§

impl PartialEq for TreeEntry

Source§

fn eq(&self, other: &TreeEntry) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TreeEntry

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.