Struct Tree 

pub struct Tree { /* private fields */ }

Implementations

impl Tree

pub fn new() -> Tree

pub fn from_entries(entries: Vec<TreeEntry>) -> Tree

pub fn try_from_decoded_entries( entries: Vec<TreeEntry>, ) -> Result<Tree, TreeError>

Build a tree from entries that are already in canonical name order.

Unlike Self::from_entries, this does not sort. Decoders use it so eager and streaming paths reject the same out-of-order or duplicate encodings instead of silently canonicalizing them.

pub fn validate(&self) -> Result<(), TreeError>

pub fn entries(&self) -> &[TreeEntry]

pub fn get(&self, name: &str) -> Option<&TreeEntry>

pub fn insert(&mut self, entry: TreeEntry)

pub fn remove(&mut self, name: &str) -> Option<TreeEntry>

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn hash(&self) -> ContentHash

pub fn iter(&self) -> impl Iterator<Item = &TreeEntry>

pub fn get_path(&self, path: &Path) -> Option<&TreeEntry>

impl Tree

pub fn decode_current_msgpack(data: &[u8]) -> Result<Tree, TreeDecodeError>

impl Tree

pub fn encode_canonical(&self) -> Result<Vec<u8>, TreeStreamError>

Encode this tree as uncompressed HTR4.

pub fn decode_canonical(data: &[u8]) -> Result<Tree, TreeStreamError>

Decode a complete HTR4 body, validating order incrementally.

impl Tree

pub fn decode_canonical_streamed(data: &[u8]) -> Result<Tree, TreeStreamError>

Decode HTR4 through the streaming reader and collect the eager Tree.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tree

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

Formats the value using the given formatter.

impl Default for Tree

fn default() -> Tree

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tree

fn deserialize<D>( deserializer: D, ) -> Result<Tree, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Tree

impl IntoIterator for Tree

type Item = TreeEntry

The type of the elements being iterated over.

type IntoIter = IntoIter<TreeEntry>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Tree as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Tree

type Item = &'a TreeEntry

The type of the elements being iterated over.

type IntoIter = Iter<'a, TreeEntry>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Tree as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for Tree

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Tree

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Tree

impl TryFrom<EncodedTreeV2> for Tree

type Error = TreeError

The type returned in the event of a conversion error.

fn try_from( encoded: EncodedTreeV2, ) -> Result<Tree, <Tree as TryFrom<EncodedTreeV2>>::Error>

Performs the conversion.