Struct tarantool::tuple::KeyDef

pub struct KeyDef { /* private fields */ }

Implementations

impl KeyDef

pub fn new<'a>( parts: impl IntoIterator<Item = &'a KeyDefPart<'a>> ) -> Result<Self>

Create key definition with key fields with passed typed on passed positions. May be used for tuple format creation and/or tuple comparison.

• items - array with key field identifiers and key field types (see FieldType)

pub fn compare(&self, tuple_a: &Tuple, tuple_b: &Tuple) -> Ordering

Compare tuples using the key definition.

• tuple_a - first tuple
• tuple_b - second tuple

Returns:

• Ordering::Equal if key_fields(tuple_a) == key_fields(tuple_b)
• Ordering::Less if key_fields(tuple_a) < key_fields(tuple_b)
• Ordering::Greater if key_fields(tuple_a) > key_fields(tuple_b)

pub fn compare_with_key<K>(&self, tuple: &Tuple, key: &K) -> Orderingwhere K: ToTupleBuffer + ?Sized,

Compare tuple with key using the key definition.

• tuple - tuple
• key - key with MessagePack array header

Returns:

• Ordering::Equal if key_fields(tuple) == parts(key)
• Ordering::Less if key_fields(tuple) < parts(key)
• Ordering::Greater if key_fields(tuple) > parts(key)

Trait Implementations

impl Debug for KeyDef

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

Formats the value using the given formatter.

impl Drop for KeyDef

fn drop(&mut self)

Executes the destructor for this type.