Struct ListColumn 

#[non_exhaustive]
pub struct ListColumn {
    pub field: String,
    pub label: Text,
    pub column_type: String,
    pub options: Value,
    pub sortable: bool,
    pub invisible: bool,
    pub width: Option<String>,
    pub align: Option<Align>,
    pub permission: Option<String>,
    pub searchable: Option<bool>,
    pub labels: Vec<ValueLabel>,
    pub editable: bool,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

field: String

Comes from the key this was written under, never from the body.

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, …).

options: Value

The keys that belong to the column’s type, as an object: in a file they are written on the column itself. Null when there are none.

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.

labels: Vec<ValueLabel>

What a stored value reads as: login_success shown as “Signed in”. A value with no label shows as stored.

editable: bool

The cell is the form field’s control, saved on change: a column whose field is on the resource’s form. Off by default.

Implementations

impl ListColumn

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

pub fn labels(self, labels: Vec<ValueLabel>) -> Self

What each stored value reads as. A value not listed shows as stored.

pub fn editable(self) -> Self

Edits the cell in the row through the form field of the same name.

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 Default for ListColumn

fn default() -> Self

A text column. The name comes from the key it is written under, and the label from the name when a file gives none.

impl<'de> Deserialize<'de> for ListColumn

fn deserialize<D: Deserializer<'de>>(de: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Serialize for ListColumn

fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.