Enum tarantool_rust_module::IteratorType

#[repr(u32)]
pub enum IteratorType {
    EQ,
    REQ,
    ALL,
    LT,
    LE,
    GE,
    GT,
    BitsAllSet,
    BitsAnySet,
    BitsAllNotSet,
    Ovelaps,
    Neigbor,
}

Controls how to iterate over tuples in an index. Different index types support different iterator types. For example, one can start iteration from a particular value (request key) and then retrieve all tuples where keys are greater or equal (= GE) to this key.

If iterator type is not supported by the selected index type, iterator constructor must fail with ER_UNSUPPORTED. To be selectable for primary key, an index must support at least ITER_EQ and ITER_GE types.

NULL value of request key corresponds to the first or last key in the index, depending on iteration direction. (first key for GE and GT types, and last key for LE and LT). Therefore, to iterate over all tuples in an index, one can use ITER_GE or ITER_LE iteration types with start key equal to NULL. For ITER_EQ, the key must not be NULL.

Variants

EQREQALLLTLEGEGTBitsAllSetBitsAnySetBitsAllNotSetOvelapsNeigbor

Trait Implementations

impl Debug for IteratorType

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Copy for IteratorType

impl Clone for IteratorType

fn clone(&self) -> IteratorType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for IteratorType

fn eq(&self, __arg_0: &IteratorType) -> 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 !=.

impl Eq for IteratorType

impl Hash for IteratorType

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].