Skip to main content

vantage_table/column/
flags.rs

1/// Column flags that define behavior and properties of columns.
2#[derive(Debug, Clone, Hash, PartialEq, Eq)]
3pub enum ColumnFlag {
4    /// Mandatory will require read/write operations to always have value for this field, it cannot be missing
5    Mandatory,
6    /// Hidden columns should be excluded from UI display
7    Hidden,
8    /// IdField marks this column as the primary identifier for the table
9    IdField,
10    /// TitleField marks this column as the display title/name for records
11    TitleField,
12    /// Searchable marks this column as searchable in text searches
13    Searchable,
14    /// Indexed marks this column as cheap to sort or filter on, hinting to generic UIs that they can offer sort headers and filter inputs without a performance penalty
15    Indexed,
16    /// Label hints to generic UIs that this column is better shown as a
17    /// small status tag attached to the record's title than as its own
18    /// column (e.g. a status / state field with a per-value color map)
19    Label,
20}