Struct RelationColumn 

pub struct RelationColumn<M> { /* private fields */ }

A column showing the record of a Deferred belongs_to or has_one field as text, or the records of a has_many one (list), which declares the field’s include so every page that renders it loads them.

use tablo_core::{RelationColumn, lens, relation};

RelationColumn::new::<AuthorResource>(
    relation!(Post.author),
    lens!(Author.name),
    |a: &Author| a.name.clone(),
);

The header and the column’s name are the field’s name, capitalized, until label replaces both. The column neither searches nor sorts.

A column over a source S shows only the related records S shows the user: the ones its scoped_query returns when it lists for the user, as a relationship choice over S offers them. A resource’s View policy plays no part: a related record to hide belongs out of the scoped query, in its query. A related record it hides, soft-deleted or another tenant’s, renders empty, and so does every record of a row loaded around the table’s or the Detail’s loader, which checks them. The row keeps what the include loaded, so a policy reading the relation sees it whole. unscoped shows whatever the include loads.

A field field_access restricts shows to a user only where the user may view it, on every resource the panel mounts over its model: a request that may not view a field new reads finds no such column. A record’s label is its title, which the mount keeps clear of every restricted field, or its key, which no field access may hide.

Implementations

impl<M> RelationColumn<M>

pub fn label(self, label: impl Into<Text>) -> Self

Replace the label the field’s name gives it, and name the column after the label, as a ComputedColumn is: two columns over one relation need two labels.

pub fn width(self, width: ColumnWidth) -> Self

Declare this column’s width.

pub fn toggleable(self) -> Self

Let each reader hide this column from their list; it starts shown.

pub fn hidden_by_default(self) -> Self

Let each reader show this column in their list; it starts hidden.

impl<M> RelationColumn<M>

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

pub fn new<S>( relation: RelationLens<M, impl ToOneRelation<S::Model> + 'static>, reads: impl Into<Reads<S::Model>>, project: impl Fn(&S::Model) -> String + Send + Sync + 'static, ) -> Self

where S: OptionSource,

Declare a column rendering project of the record relation loads, when S shows it. reads names the fields of the record project reads, a lens! or a Reads: a request S hides one of them from finds no such column.

pub fn of<S>( relation: RelationLens<M, impl ToOneRelation<S::Model> + 'static>, ) -> Self

where S: OptionSource,

Declare a column showing the record relation loads by S’s label, when S shows it: for a resource, the record_title its detail page is titled with.

use tablo_core::{RelationColumn, relation};

RelationColumn::of::<AuthorResource>(relation!(Post.author));

pub fn list<S>(relation: RelationLens<M, Deferred<Vec<S::Model>>>) -> Self

where S: OptionSource,

Declare a column listing the records a has_many relation loads that S shows, a many-to-many #[has_many(via = ..)] one included, each by S’s label, joined by commas.

use tablo_core::{RelationColumn, relation};

RelationColumn::list::<TagResource>(relation!(Post.tags));

pub fn unscoped<T>( relation: RelationLens<M, impl ToOneRelation<T> + 'static>, project: impl Fn(&T) -> String + Send + Sync + 'static, ) -> Self

Declare a column rendering project of whatever record relation loads, under no resource’s query, policy or field access: for a related model no resource administers. A panel mounting a resource that restricts a field of the related model refuses it. A row loaded without the column’s include renders "(unloaded)" and fails a debug assertion.

Trait Implementations

impl<M> Clone for RelationColumn<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

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.

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 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.

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 alignment(&self) -> Alignment

Where the header and the cells align their content.

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

The predicate a search for term adds, or None when the column does not join the table’s search. A column that joins it answers Some for every non-empty, trimmed term.

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

The ordering a sort on this column applies, or None when the header does not link to a sort on it. A sortable column answers Some either way.

impl<M> Debug for RelationColumn<M>

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

Formats the value using the given formatter.

impl<M> IntoColumns<M> for RelationColumn<M>

where Self: Column<M> + 'static,

impl<M> IntoDetail<M> for RelationColumn<M>

where Self: Column<M> + 'static,

fn into_detail(self) -> Detail<M>