Skip to main content

obj_iter_index_range

Function obj_iter_index_range 

Source
#[unsafe(no_mangle)]
pub unsafe extern "C" fn obj_iter_index_range( txn: *mut obj_read_txn_t, collection: *const c_char, index_name: *const c_char, lower: *const u8, lower_len: usize, lower_inclusive: bool, upper: *const u8, upper_len: usize, upper_inclusive: bool, out_iter: *mut *mut obj_iter_t, ) -> obj_error_t
Expand description

Construct an iterator over the index range [lower, upper] (bounds applied per *_inclusive flag) on index_name in collection. NULL lower / upper means unbounded.

ยงSafety

  • txn, collection, index_name, out_iter must follow the usual non-null + NUL-terminated conventions.
  • lower / upper may be NULL (paired with _len = 0 and treated as unbounded) or point to _len readable bytes.