From 0f2bd1f3a2c5e3ef311ccdfa12cf5c65ecb79526 Mon Sep 17 00:00:00 2001 From: Jussi Saurio Date: Mon, 19 May 2025 16:42:38 +0300 Subject: [PATCH] Doc comment for IndexKeyInfo (thanks copilot) Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- core/types.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/core/types.rs b/core/types.rs index 606305e30..29bfc740e 100644 --- a/core/types.rs +++ b/core/types.rs @@ -1101,9 +1101,17 @@ impl Default for IndexKeySortOrder { } #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)] +/// Metadata about an index, used for handling and comparing index keys. +/// +/// This struct provides information about the sorting order of columns, +/// whether the index includes a row ID, and the total number of columns +/// in the index. pub struct IndexKeyInfo { + /// Specifies the sorting order (ascending or descending) for each column in the index. pub sort_order: IndexKeySortOrder, + /// Indicates whether the index includes a row ID column. pub has_rowid: bool, + /// The total number of columns in the index, including the row ID column if present. pub num_cols: usize, }