Struct grovedb_path::SubtreePathBuilder

pub struct SubtreePathBuilder<'b, B> { /* private fields */ }

Path to a GroveDB’s subtree.

Implementations

impl SubtreePathBuilder<'static, [u8; 0]>

pub fn new() -> Self

Creates empty subtree path

impl<B> SubtreePathBuilder<'_, B>

pub fn len(&self) -> usize

Returns the length of the subtree path.

pub fn is_empty(&self) -> bool

Returns whether the path is empty (the root tree).

impl<'b, B: AsRef<[u8]>> SubtreePathBuilder<'b, B>

pub fn derive_owned(&'b self) -> SubtreePathBuilder<'b, B>

Get a derived path that will use another subtree path (or reuse the base slice) as it’s base, then could be edited in place.

pub fn derive_parent(&self) -> Option<(SubtreePath<'_, B>, &[u8])>

Get a derived path for a parent and a chopped segment. Returned SubtreePath will be linked to this SubtreePath because it might contain owned data and it has to outlive SubtreePath.

pub fn derive_owned_with_child<'s, S>( &'b self, segment: S, ) -> SubtreePathBuilder<'b, B>

where S: Into<CowLike<'s>>, 's: 'b,

Get a derived path with a child path segment added.

pub fn push_segment(&mut self, segment: &[u8])

Adds path segment in place.

pub fn reverse_iter(&'b self) -> SubtreePathIter<'b, B>

Returns an iterator for the subtree path by path segments.

pub fn to_vec(&self) -> Vec<Vec<u8>>

Collect path as a vector of vectors, but this actually negates all the benefits of this library.

pub fn is_root(&self) -> bool

Retuns true if the subtree path is empty, so it points to the root tree.

Trait Implementations

impl<'b, B: Debug> Debug for SubtreePathBuilder<'b, B>

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

Formats the value using the given formatter.

impl Default for SubtreePathBuilder<'static, [u8; 0]>

fn default() -> Self

Returns the “default value” for a type.

impl<'s, 'b, B> From<&'s SubtreePath<'b, B>> for SubtreePathBuilder<'b, B>

fn from(value: &'s SubtreePath<'b, B>) -> Self

Converts to this type from the input type.

impl<'s, 'b, B> From<&'s SubtreePathBuilder<'b, B>> for SubtreePath<'s, B>

Create a link to existing SubtreePath that cannot outlive it, because it possibly owns some of the path segments.

fn from(value: &'s SubtreePathBuilder<'b, B>) -> Self

Converts to this type from the input type.

impl<'b, B: AsRef<[u8]>> Hash for SubtreePathBuilder<'b, B>

Hash order is the same as iteration order: from most deep path segment up to root.

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'bl, 'br, BL, BR> PartialEq<SubtreePath<'br, BR>> for SubtreePathBuilder<'bl, BL>

where BL: AsRef<[u8]>, BR: AsRef<[u8]>,

fn eq(&self, other: &SubtreePath<'br, BR>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'bl, 'br, BL, BR> PartialEq<SubtreePathBuilder<'br, BR>> for SubtreePath<'bl, BL>

where BL: AsRef<[u8]>, BR: AsRef<[u8]>,

fn eq(&self, other: &SubtreePathBuilder<'br, BR>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'bl, 'br, BL, BR> PartialEq<SubtreePathBuilder<'br, BR>> for SubtreePathBuilder<'bl, BL>

where BL: AsRef<[u8]>, BR: AsRef<[u8]>,

fn eq(&self, other: &SubtreePathBuilder<'br, BR>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'b, B: AsRef<[u8]>> Eq for SubtreePathBuilder<'b, B>