mirror of
https://github.com/aljazceru/turso.git
synced 2025-12-29 05:54:21 +01:00
Doc comment for IndexKeyInfo (thanks copilot)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
committed by
Jussi Saurio
parent
42dc824794
commit
0f2bd1f3a2
@@ -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,
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user