[Tarantool-patches] [PATCH 14/14] WIP: module api: add box_key_def_validate_key()

[Alexander Turenko]

XXX: Add a module API test.

Part of #5273
---
 src/box/key_def_api.c | 15 +++++++++++++++
 src/box/key_def_api.h | 15 +++++++++++++++
 src/exports.h         |  1 +
 3 files changed, 31 insertions(+)

diff --git a/src/box/key_def_api.c b/src/box/key_def_api.c
index 1257e9060..2555b9fdd 100644
--- a/src/box/key_def_api.c
+++ b/src/box/key_def_api.c
@@ -305,4 +305,19 @@ box_tuple_extract_key_ex(box_tuple_t *tuple, box_key_def_t *key_def,
 	return tuple_extract_key(tuple, key_def, multikey_idx, key_size_ptr);
 }
 
+int
+box_key_def_validate_key(const box_key_def_t *key_def, const char *key,
+			 bool allow_nullable)
+{
+	uint32_t part_count = mp_decode_array(&key);
+	if (part_count > key_def->part_count) {
+		diag_set(ClientError, ER_KEY_PART_COUNT, key_def->part_count,
+			 part_count);
+		return -1;
+	}
+	const char *key_end;
+	return key_validate_parts(key_def, key, part_count, allow_nullable,
+				  &key_end);
+}
+
 /* }}} API functions implementations */
diff --git a/src/box/key_def_api.h b/src/box/key_def_api.h
index 28fcc32da..8dd6eb10b 100644
--- a/src/box/key_def_api.h
+++ b/src/box/key_def_api.h
@@ -36,6 +36,7 @@ extern "C" {
 #endif /* defined(__cplusplus) */
 
 #include <stdint.h>
+#include <stdbool.h>
 #include "trivia/util.h"
 
 typedef struct tuple box_tuple_t;
@@ -263,6 +264,20 @@ API_EXPORT char *
 box_tuple_extract_key_ex(box_tuple_t *tuple, box_key_def_t *key_def,
 			 int multikey_idx, uint32_t *key_size_ptr);
 
+/**
+ * Check that parts of the key match with the key definition.
+ *
+ * @param key_def        Key definition.
+ * @param key            MessagePack'ed data for matching.
+ * @param allow_nullable True if nullable parts are allowed.
+ *
+ * @retval 0  The key is valid.
+ * @retval -1 The key is invalid.
+ */
+API_EXPORT int
+box_key_def_validate_key(const box_key_def_t *key_def, const char *key,
+			 bool allow_nullable);
+
 /** \endcond public */
 
 /*
diff --git a/src/exports.h b/src/exports.h
index 6ddc2e9b0..48894ea72 100644
--- a/src/exports.h
+++ b/src/exports.h
@@ -34,6 +34,7 @@ EXPORT(box_key_def_dump_parts)
 EXPORT(box_key_def_merge)
 EXPORT(box_key_def_new)
 EXPORT(box_key_def_new_ex)
+EXPORT(box_key_def_validate_key)
 EXPORT(box_key_part_def_create)
 EXPORT(box_latch_delete)
 EXPORT(box_latch_lock)
-- 
2.25.0