Struct ProductZipperG 

pub struct ProductZipperG<'trie, PrimaryZ, SecondaryZ, V>
where
    V: Clone + Send + Sync,
{ /* private fields */ }

A Zipper type that moves through a Cartesian product trie created by extending each path in a primary trie with the root of the next secondardary trie, doing it recursively for all provided tries

Compared to ProductZipper, this is a generic virtual zipper that works without inspecting the inner workings of primary and secondary zippers. ProductZipperG is more general, while ProductZipper is faster in situations where it can be used.

NOTE: In the future, this generic type will be renamed to ProductZipper, and the existing ProductZipper will be renamed something else or removed entirely.

Implementations

impl<'trie, PrimaryZ, SecondaryZ, V> ProductZipperG<'trie, PrimaryZ, SecondaryZ, V>

where V: Clone + Send + Sync, PrimaryZ: ZipperMoving, SecondaryZ: ZipperMoving,

pub fn new<ZipperList>(primary: PrimaryZ, other_zippers: ZipperList) -> Self

where ZipperList: IntoIterator<Item = SecondaryZ>, PrimaryZ: ZipperValues<V>, SecondaryZ: ZipperValues<V>,

Creates a new ProductZipper from the provided zippers

Trait Implementations

impl<V: Clone + Send + Sync + Unpin, PrimaryZ, SecondaryZ> Debug for ProductZipperG<'_, PrimaryZ, SecondaryZ, V>

where PrimaryZ: ZipperAbsolutePath, SecondaryZ: ZipperAbsolutePath,

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

Formats the value using the given formatter.

impl<'trie, PrimaryZ, SecondaryZ, V> Zipper for ProductZipperG<'trie, PrimaryZ, SecondaryZ, V>

where V: Clone + Send + Sync, PrimaryZ: ZipperMoving + Zipper, SecondaryZ: ZipperMoving + Zipper,

fn path_exists(&self) -> bool

Returns true if the zipper’s focus is on a path within the trie, otherwise false

fn is_val(&self) -> bool

Returns true if there is a value at the zipper’s focus, otherwise false

fn child_count(&self) -> usize

Returns the number of child branches from the focus node

fn child_mask(&self) -> ByteMask

Returns 256-bit mask indicating which children exist from the branch at the zipper’s focus

fn is_value(&self) -> bool

👎Deprecated

Deprecated alias for Zipper::is_val

impl<'trie, PrimaryZ, SecondaryZ, V> ZipperAbsolutePath for ProductZipperG<'trie, PrimaryZ, SecondaryZ, V>

where V: Clone + Send + Sync, PrimaryZ: ZipperAbsolutePath, SecondaryZ: ZipperMoving,

fn origin_path(&self) -> &[u8]

Returns the entire path from the zipper’s origin to its current focus

fn root_prefix_path(&self) -> &[u8]

Returns the path from the zipper’s origin to the zipper’s root

impl<'trie, PrimaryZ, SecondaryZ, V> ZipperConcrete for ProductZipperG<'trie, PrimaryZ, SecondaryZ, V>

where V: Clone + Send + Sync, PrimaryZ: ZipperMoving + ZipperConcrete, SecondaryZ: ZipperMoving + ZipperConcrete,

fn shared_node_id(&self) -> Option<u64>

Get an identifier unique to the node at the zipper’s focus, if the zipper’s focus is at the root of a node in memory. When zipper’s focus is inside of a node, returns None.

fn is_shared(&self) -> bool

Returns true if the zipper’s focus is at a location that may be accessed via two or more distinct paths

impl<'trie, PrimaryZ, SecondaryZ, V> ZipperIteration for ProductZipperG<'trie, PrimaryZ, SecondaryZ, V>

where V: Clone + Send + Sync, PrimaryZ: ZipperIteration, SecondaryZ: ZipperIteration,

fn to_next_val(&mut self) -> bool

Systematically advances to the next value accessible from the zipper, traversing in a depth-first order

fn descend_last_path(&mut self) -> bool

Descends the zipper to the end of the last path (last by sort order) reachable by descent from the current focus.

fn descend_first_k_path(&mut self, k: usize) -> bool

Descends the zipper’s focus k bytes, following the first child at each branch, and continuing with depth-first exploration until a path that is k bytes from the focus has been found

fn to_next_k_path(&mut self, k: usize) -> bool

Moves the zipper’s focus to the next location with the same path length as the current focus, following a depth-first exploration from a common root k steps above the current focus

impl<'trie, PrimaryZ, SecondaryZ, V> ZipperMoving for ProductZipperG<'trie, PrimaryZ, SecondaryZ, V>

where V: Clone + Send + Sync, PrimaryZ: ZipperMoving, SecondaryZ: ZipperMoving,

fn at_root(&self) -> bool

Returns true if the zipper’s focus is at its root, and it cannot ascend further, otherwise returns false

fn reset(&mut self)

Resets the zipper’s focus back to its root

fn path(&self) -> &[u8]

Returns the path from the zipper’s root to the current focus

fn val_count(&self) -> usize

Returns the total number of values contained at and below the zipper’s focus, including the focus itself

fn descend_to_existing<K: AsRef<[u8]>>(&mut self, path: K) -> usize

Moves the zipper deeper into the trie, following the path specified by k, relative to the current zipper focus. Descent stops at the point where the path does not exist

fn descend_to<K: AsRef<[u8]>>(&mut self, path: K)

Moves the zipper deeper into the trie, to the key specified relative to the current zipper focus

fn descend_to_byte(&mut self, k: u8)

Moves the zipper one byte deeper into the trie. Identical in effect to descend_to with a 1-byte key argument

fn descend_indexed_byte(&mut self, child_idx: usize) -> bool

Descends the zipper’s focus one byte into a child branch uniquely identified by child_idx

fn descend_first_byte(&mut self) -> bool

Descends the zipper’s focus one step into the first child branch in a depth-first traversal

fn descend_until(&mut self) -> bool

Descends the zipper’s focus until a branch or a value is encountered. Returns true if the focus moved otherwise returns false

fn to_next_sibling_byte(&mut self) -> bool

Moves the zipper’s focus to the next sibling byte with the same parent

fn to_prev_sibling_byte(&mut self) -> bool

Moves the zipper’s focus to the previous sibling byte with the same parent

fn ascend(&mut self, steps: usize) -> bool

Ascends the zipper steps steps. Returns true if the zipper sucessfully moved steps

fn ascend_byte(&mut self) -> bool

Ascends the zipper up a single byte. Equivalent to passing 1 to ascend

fn ascend_until(&mut self) -> bool

Ascends the zipper to the nearest upstream branch point or value. Returns true if the zipper focus moved upwards, otherwise returns false if the zipper was already at the root

fn ascend_until_branch(&mut self) -> bool

Ascends the zipper to the nearest upstream branch point, skipping over values along the way. Returns true if the zipper focus moved upwards, otherwise returns false if the zipper was already at the root

fn move_to_path<K: AsRef<[u8]>>(&mut self, path: K) -> usize

Moves the zipper’s focus to a specific location specified by path, relative to the zipper’s root

fn descend_to_check<K: AsRef<[u8]>>(&mut self, k: K) -> bool

Fused descend_to and path_exists. Moves the focus and returns whether or not the path exists at the new focus location

fn descend_to_val<K: AsRef<[u8]>>(&mut self, k: K) -> usize

Moves the zipper deeper into the trie, following the path specified by k, relative to the current zipper focus. Descent stops if a value is encountered or if the path ceases to exist.

fn descend_to_value<K: AsRef<[u8]>>(&mut self, k: K) -> usize

👎Deprecated

Deprecated alias for ZipperMoving::descend_to_val

fn descend_to_existing_byte(&mut self, k: u8) -> bool

Moves the zipper one byte deeper into the trie, if the specified path byte exists in the child_mask.

fn descend_indexed_branch(&mut self, idx: usize) -> bool

👎Deprecated

A deprecated alias for ZipperMoving::descend_indexed_byte

fn descend_last_byte(&mut self) -> bool

Descends the zipper’s focus one step into the last child branch

fn to_next_step(&mut self) -> bool

Advances the zipper to visit every existing path within the trie in a depth-first order

impl<'trie, PrimaryZ, SecondaryZ, V> ZipperPathBuffer for ProductZipperG<'trie, PrimaryZ, SecondaryZ, V>

where V: Clone + Send + Sync, PrimaryZ: ZipperMoving + ZipperPathBuffer, SecondaryZ: ZipperMoving + ZipperPathBuffer,

unsafe fn origin_path_assert_len(&self, len: usize) -> &[u8]

Internal method to get the path, beyond its length. Panics if len > the path’s capacity, or if the zipper is relative and doesn’t have an origin_path

fn prepare_buffers(&mut self)

Make sure the path buffer is allocated, to facilitate zipper movement

fn reserve_buffers(&mut self, path_len: usize, stack_depth: usize)

Reserve buffer space within the zipper’s path buffer and node stack

impl<'trie, PZ, SZ, V: TrieValue> ZipperProduct for ProductZipperG<'trie, PZ, SZ, V>

where PZ: ZipperMoving + Zipper + ZipperAbsolutePath + ZipperIteration, SZ: ZipperMoving + Zipper + ZipperAbsolutePath + ZipperIteration,

fn focus_factor(&self) -> usize

Returns the index of the factor containing the ProductZipper focus

fn factor_count(&self) -> usize

Returns the number of factors composing the ProductZipper

fn path_indices(&self) -> &[usize]

Returns a slice of the path indices that represent the end-points of the portion of the path from each factor

impl<'trie, PrimaryZ, SecondaryZ, V> ZipperReadOnlyConditionalValues<'trie, V> for ProductZipperG<'trie, PrimaryZ, SecondaryZ, V>

where V: Clone + Send + Sync, PrimaryZ: ZipperMoving + ZipperReadOnlyConditionalValues<'trie, V>, SecondaryZ: ZipperMoving + ZipperReadOnlyConditionalValues<'trie, V>,

type WitnessT = (<PrimaryZ as ZipperReadOnlyConditionalValues<'trie, V>>::WitnessT, Vec<<SecondaryZ as ZipperReadOnlyConditionalValues<'trie, V>>::WitnessT>)

The type that acts as a witness for the validity of the zipper

fn witness<'w>(&self) -> Self::WitnessT

Creates a witness that can allow acquisition of longer-lived borrows of values, while the zipper itself is mutated

fn get_val_with_witness<'w>(&self, witness: &'w Self::WitnessT) -> Option<&'w V>

where 'trie: 'w,

Returns a refernce to the value at the zipper’s focus, or None if there is no value

impl<'trie, PrimaryZ, SecondaryZ, V> ZipperReadOnlyValues<'trie, V> for ProductZipperG<'trie, PrimaryZ, SecondaryZ, V>

where V: Clone + Send + Sync, PrimaryZ: ZipperMoving + ZipperReadOnlyValues<'trie, V>, SecondaryZ: ZipperMoving + ZipperReadOnlyValues<'trie, V>,

fn get_val(&self) -> Option<&'trie V>

Returns a refernce to the value at the zipper’s focus, or None if there is no value

fn get_value(&self) -> Option<&'a V>

👎Deprecated

Deprecated alias for ZipperReadOnlyValues::get_val

impl<'trie, PrimaryZ, SecondaryZ, V> ZipperValues<V> for ProductZipperG<'trie, PrimaryZ, SecondaryZ, V>

where V: Clone + Send + Sync, PrimaryZ: ZipperMoving + ZipperValues<V>, SecondaryZ: ZipperMoving + ZipperValues<V>,

fn val(&self) -> Option<&V>

Returns a refernce to the value at the zipper’s focus, or None if there is no value

fn value(&self) -> Option<&V>

👎Deprecated

Deprecated alias for ZipperValues::val