Struct ListColumn 

pub struct ListColumn {
    pub field: String,
    pub label: Text,
    pub column_type: String,
    pub sortable: bool,
    pub invisible: bool,
    pub width: Option<String>,
    pub align: Option<Align>,
    pub permission: Option<String>,
    pub searchable: Option<bool>,
}

Fields

field: String

label: Text

The column header, localized at render. Serde stays a plain string.

column_type: String

The column-type registry key (text, date, boolean, status_pill, …).

sortable: bool

Whether the header sorts. Off for a column whose order means nothing.

invisible: bool

Hidden until the operator picks it from the column chooser.

width: Option<String>

A CSS width, 10% or 120px. None shares the remaining space.

align: Option<Align>

permission: Option<String>

A permission the operator must hold to see the column at all: it is then not queried, sorted, searched, picked or exported for them.

searchable: Option<bool>

Whether the list’s search box looks in this column. None follows the column type: text columns are searched, the rest are not, because a substring match on a boolean or a stored timestamp answers nonsense.

Implementations

impl ListColumn

pub fn new(field: &str, label: impl Into<Text>) -> Self

pub fn datetime(self) -> Self

Render as a date and time in the display timezone.

pub fn date(self) -> Self

Render as a date in the display timezone.

pub fn time(self) -> Self

Render as a time in the display timezone.

pub fn yes_no(self) -> Self

Render a boolean as Yes/No.

pub fn pill(self) -> Self

Render as a coloured status pill.

pub fn searchable(self, searchable: bool) -> Self

Overrides whether the search box looks in this column.

pub fn sortable(self, sortable: bool) -> Self

pub fn invisible(self) -> Self

Hidden by default; the column chooser still offers it.

pub fn width(self, width: impl Into<String>) -> Self

pub fn align(self, align: Align) -> Self

pub fn require(self, permission: impl Into<String>) -> Self

Shown only to an operator holding permission.

Trait Implementations

impl Clone for ListColumn

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListColumn

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for ListColumn

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.