Function tarantool_rust_module::box_index_get [] [src]

pub unsafe extern "C" fn box_index_get(
    space_id: u32,
    index_id: u32,
    key: *const c_char,
    key_end: *const c_char,
    result: *mut *mut BoxTuple
) -> c_int

Get a tuple from index by the key.

Please note that this function works much more faster than box_select() or box_index_iterator() + box_iterator_next().

\param space_id space identifier \param index_id index identifier \param key encoded key in MsgPack Array format ([part1, part2, ...]). \param key_end the end of encoded \a key \param[out] result a tuple or NULL if index is empty \retval -1 on error (check box_error_last()) \retval 0 on success \pre key != NULL \sa \code box.space[space_id].index[index_id]:get(key) \endcode