Trait Keys

pub trait Keys {
    // Required methods
    fn next(&mut self, internal: &Internal) -> Result<usize, KeyError>;
    fn finalize(&mut self) -> Result<(), KeyError>;

    // Provided methods
    fn chain<U: IntoKeys>(self, other: U) -> Chain<Self, U::IntoKeys>
       where Self: Sized { ... }
    fn track(self) -> Track<Self>
       where Self: Sized { ... }
    fn short(self) -> Short<Self>
       where Self: Sized { ... }
}

Capability to yield and look up Keys

Required Methods

fn next(&mut self, internal: &Internal) -> Result<usize, KeyError>

Look up the next key in a Internal and convert to usize index.

This must be fused (like core::iter::FusedIterator).

fn finalize(&mut self) -> Result<(), KeyError>

Finalize the keys, ensure there are no more.

This must be fused.

Provided Methods

fn chain<U: IntoKeys>(self, other: U) -> Chain<Self, U::IntoKeys>

where Self: Sized,

Chain another Keys to this one.

fn track(self) -> Track<Self>

where Self: Sized,

Track depth

fn short(self) -> Short<Self>

where Self: Sized,

Track whether a leaf node is reached

Implementations on Foreign Types

impl<T: Keys + ?Sized> Keys for &mut T

fn next(&mut self, internal: &Internal) -> Result<usize, KeyError>

fn finalize(&mut self) -> Result<(), KeyError>

Implementors

impl Keys for Packed

impl<K: Keys> Keys for Short<K>

impl<K: Keys> Keys for Track<K>

impl<T> Keys for KeysIter<T>

where T: Iterator, T::Item: Key,

impl<T: Keys, U: Keys> Keys for Chain<T, U>