Trait Column 

pub trait Column<M>: Send + Sync {
    // Required methods
    fn name(&self) -> &str;
    fn label(&self) -> Text;
    fn text(&self, cx: &Cx, row: &M) -> String;

    // Provided methods
    fn cell<'a>(&self, cx: &'a Cx, row: &M) -> BoxView<'a> { ... }
    fn entry<'a>(&self, cx: &'a Cx, row: &M) -> BoxView<'a> { ... }
    fn column_width(&self) -> ColumnWidth { ... }
    fn toggle(&self) -> ColumnToggle { ... }
    fn alignment(&self) -> Alignment { ... }
    fn is_searchable(&self) -> bool { ... }
    fn search_expr(&self, _term: &str) -> Option<Expr<bool>> { ... }
    fn is_sortable(&self) -> bool { ... }
    fn order_by(&self, _descending: bool) -> Option<OrderByExpr> { ... }
    fn includes(&self) -> Includes<M> { ... }
    fn reads(&self) -> Option<Reads<M>> { ... }
}

One column of a table or a Detail declares its label, its value read off the record, and its query predicates.

struct Initials;

impl Column<User> for Initials {
    fn name(&self) -> &str {
        "initials"
    }
    fn label(&self) -> Text {
        "Initials".into()
    }
    fn text(&self, _cx: &Cx, row: &User) -> String {
        row.name
            .split_whitespace()
            .filter_map(|w| w.chars().next())
            .collect()
    }
}

Only name, label and text are required.

Required Methods

fn name(&self) -> &str

The column’s identifier, distinct within its table.

fn label(&self) -> Text

The header text.

fn text(&self, cx: &Cx, row: &M) -> String

The row’s value as plain text.

Provided Methods

fn cell<'a>(&self, cx: &'a Cx, row: &M) -> BoxView<'a>

The row’s table cell.

fn entry<'a>(&self, cx: &'a Cx, row: &M) -> BoxView<'a>

The record’s entry on a detail page: the label over the cell.

fn column_width(&self) -> ColumnWidth

The width the column claims.

fn toggle(&self) -> ColumnToggle

Whether each reader may hide or show the column in their list, and how it starts. A detail page shows every column.

fn alignment(&self) -> Alignment

Where the header and the cells align their content.

fn is_searchable(&self) -> bool

Whether the column joins the table’s search.

fn search_expr(&self, _term: &str) -> Option<Expr<bool>>

The predicate a search for term adds.

fn is_sortable(&self) -> bool

Whether the header links to a sort on this column.

fn order_by(&self, _descending: bool) -> Option<OrderByExpr>

The ordering a sort on this column applies.

fn includes(&self) -> Includes<M>

The relations text, cell and entry read.

fn reads(&self) -> Option<Reads<M>>

The fields of the row text, cell, entry, search_expr and order_by read, or None when the column does not say.

A panel drops a column reading a field field_access hides from the user, and refuses to mount a panel restricting a field whose columns answer None. The built-in columns answer their own field.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<M, T> Column<M> for ColorColumn<M, T>

where M: Model + Send + Sync + 'static, T: FormScalar + Send + Sync + 'static,

impl<M, T> Column<M> for DateColumn<M, T>

where M: Model + Send + Sync + 'static, T: DateValue,

impl<M, T> Column<M> for EmbeddedColumn<M, T>

where M: Model + Send + Sync + 'static, T: EmbeddedForm + Send + Sync + 'static,

impl<M, T> Column<M> for ImageColumn<M, T>

where M: Model + Send + Sync + 'static, T: FormScalar + Send + Sync + 'static,

impl<M, T> Column<M> for RepeaterColumn<M, T>

where M: Model + Send + Sync + 'static, T: FormInput,

impl<M, T> Column<M> for RichTextColumn<M, T>

where M: Model + Send + Sync + 'static, T: FormScalar + Send + Sync + 'static,

impl<M, T> Column<M> for TextColumn<M, T>

where M: Model + Send + Sync + 'static, T: Send + Sync + 'static,

impl<M> Column<M> for BooleanColumn<M>

where M: Model + Send + Sync + 'static,

impl<M> Column<M> for ComputedColumn<M>

where M: Model + Send + Sync + 'static,

impl<M> Column<M> for CountColumn<M>

where M: Model + Send + Sync + 'static,

impl<M> Column<M> for FileColumn<M>

where M: Model + Send + Sync + 'static,

impl<M> Column<M> for RelationColumn<M>

where M: Model + Send + Sync + 'static,