Struct ListConfig 

#[non_exhaustive]
pub struct ListConfig {

    pub entity: String,
    pub title: Text,
    pub columns: Vec<ListColumn>,
    pub order_by: String,
    pub order_dir: SortDir,
    pub per_page: i64,
    pub id_field: String,
    pub edit_base: Option<String>,
    pub creatable: bool,
    pub filters: Vec<ListFilter>,
    pub deletable: bool,
    pub exportable: bool,
    pub reorder: Option<ReorderConfig>,
    pub tree: Option<TreeConfig>,
    pub toolbar: Vec<ToolbarButton>,
    pub search: SearchConfig,
    pub per_page_options: Vec<i64>,
    pub no_records_message: Option<Text>,
    pub row_click: RowClick,
    pub remember: bool,
    /* private fields */
}

A list view descriptor: which table, which columns, default ordering, page size, and (optionally) where per-row edit links point.

Built with ListConfig::new plus its builder methods. Non-exhaustive, so a struct literal outside this crate cannot freeze the field set at 1.0; that rules out ..Default::default() too, which is why the builders exist.

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.

entity: String

title: Text

The screen title, localized at render. Serde stays a plain string.

columns: Vec<ListColumn>

order_by: String

order_dir: SortDir

per_page: i64

id_field: String

edit_base: Option<String>

When set, rows link to {edit_base}/{id}/edit.

creatable: bool

Whether to offer a “New” link to {edit_base}/new. A resource that only edits existing records (no create screen) sets this false.

filters: Vec<ListFilter>

Filters offered above the table. Empty hides the bar.

deletable: bool

Whether rows can be selected and deleted from this list. Off by default: a list that shows a log, or records another screen owns, has no business offering it.

exportable: bool

Whether this resource offers an export. Off by default: exporting is a capability a resource opts into, not something every list should carry.

reorder: Option<ReorderConfig>

Rows kept in an order of their own, held in an integer column. Off by default; reorder: true in a file orders by sort_order.

tree: Option<TreeConfig>

Rows shown as a tree on their own parent column. Off by default; tree: true in a file reads parent_id.

toolbar: Vec<ToolbarButton>

Extra buttons in the toolbar, beside New and the export menu.

search: SearchConfig

per_page_options: Vec<i64>

Page sizes the operator may choose from in the list setup, remembered with their column choice. Empty offers no choice.

no_records_message: Option<Text>

Shown when the list has no records at all. None shows “No records yet.”

row_click: RowClick

What clicking a row does. Default open: the row opens its record when the list has an edit_base.

remember: bool

Whether the sort, search, filters and page an operator last used come back when they return to the list. Default true.

Implementations

impl ListConfig

pub fn new( entity: impl Into<String>, title: impl Into<Text>, columns: Vec<ListColumn>, ) -> ListConfig

A list over entity titled title, showing columns.

Everything else takes the defaults below and is opted into through a builder method, so a field added later costs existing descriptors nothing.

pub fn order(self, column: impl Into<String>, dir: SortDir) -> ListConfig

Orders by column in dir rather than newest id first.

pub fn per_page(self, rows: i64) -> ListConfig

pub fn id_field(self, column: impl Into<String>) -> ListConfig

The primary-key column, when it is not id.

pub fn edit_base(self, base: impl Into<String>) -> ListConfig

Links rows to {base}/{id}/edit.

pub fn creatable(self) -> ListConfig

Offers a New link to {edit_base}/new. Opt in, matching the read-only default: a list over a log, or over records another screen owns, should not invite an operator to create one.

pub fn exportable(self) -> ListConfig

Offers CSV and JSON exports of the current query. Opt in: a resource whose rows should not leave the panel simply never calls this, and the route is not registered for it.

pub fn filters(self, filters: Vec<ListFilter>) -> ListConfig

pub fn deletable(self) -> ListConfig

Lets rows be selected and deleted. Off by default: a list showing a log, or records another screen owns, has no business offering it.

pub fn tree(self, tree: TreeConfig) -> ListConfig

Shows the rows as a tree on their parent column: the list opens on the top level, and a row with children expands in place.

pub fn reorder(self, column: impl Into<String>) -> ListConfig

Keeps the rows in an order of their own, held in column: the list opens in that order with a grip and Move up / Move down on every row.

pub fn toolbar(self, buttons: Vec<ToolbarButton>) -> ListConfig

pub fn search(self, search: SearchConfig) -> ListConfig

pub fn per_page_options(self, sizes: Vec<i64>) -> ListConfig

pub fn no_records_message(self, text: impl Into<Text>) -> ListConfig

pub fn row_click(self, action: RowClick) -> ListConfig

What clicking a row does. Default: it opens the record.

pub fn remember(self, remember: bool) -> ListConfig

Whether the query an operator last used comes back when they return. Default true.

Trait Implementations

impl Clone for ListConfig

fn clone(&self) -> ListConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListConfig

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

Formats the value using the given formatter.

impl Default for ListConfig

fn default() -> ListConfig

A minimal list: no columns, newest-id first, 25 to a page, read-only.

Descriptors use this as the tail of a struct literal (..Default::default()) and set only what they mean. A field added here later is then additive for every descriptor rather than breaking it, which three consecutive additions made the case for.

impl<'de> Deserialize<'de> for ListConfig

where ListConfig: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<ListConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ListConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.