Skip to main content

ComputedColumn

Struct ComputedColumn 

Source
pub struct ComputedColumn<M> { /* private fields */ }
Expand description

A display-only column rendering any text from the row, with no query predicate.

tablo_core::ComputedColumn::new("Words", |p: &Post| {
    p.body.split_whitespace().count().to_string()
});

A closure that reads a relation declares it with include_unscoped, so the page loads it. One relation’s record or count is a RelationColumn or a CountColumn, which declare their own and show only what the related resource shows the user.

It maps to no column, so it neither searches nor sorts.

A badge shows the text in an outline badge, with a dot in the color the row gives it:

use tablo_core::{Color, ComputedColumn, Reads, lens};

ComputedColumn::new("Size", |o: &Order| {
    if o.total_cents > 100_00 {
        "Large"
    } else {
        "Small"
    }
    .to_string()
})
.badge()
.color(|o: &Order| (o.total_cents > 100_00).then_some(Color::Success))
.reading(Reads::of(lens!(Order.total_cents)));

Implementations§

Source§

impl<M> ComputedColumn<M>
where M: Model,

Source

pub fn new( label: impl Into<Text>, project: impl Fn(&M) -> String + Send + Sync + 'static, ) -> Self

Declare a column headed label rendering project(row), named after the label: its plain text in lowercase, or its message’s id.

Source

pub fn badge(self) -> Self

Show the text as a badge, with a dot in its color.

Source

pub fn color( self, color: impl Fn(&M) -> Option<Color> + Send + Sync + 'static, ) -> Self

Color the text by color(row): its badge’s dot, or the text itself when it is no badge. reading declares what it reads, beside the projection.

Source

pub fn include_unscoped<T>(self, relation: impl Into<Include<M, T>>) -> Self

Declare a relation the projection reads, so the table loads it. The projection reads whatever the include loads, under no resource’s query or policy, as an unscoped relation column does: another tenant’s record, or one the user may not view, reaches it.

Source

pub fn reading(self, reads: Reads<M>) -> Self

Declare the fields the projection and its color read, which a resource restricting a field with field_access needs: the column shows only to a user who may view every one.

Source

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

Declare this column’s width.

Source

pub fn align(self, alignment: Alignment) -> Self

Align the header and the cells.

Source

pub fn toggleable(self) -> Self

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

Source

pub fn hidden_by_default(self) -> Self

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

Trait Implementations§

Source§

impl<M> Clone for ComputedColumn<M>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<M> Column<M> for ComputedColumn<M>
where M: Model + Send + Sync + 'static,

Source§

fn name(&self) -> &str

The column’s identifier, distinct within its table.
Source§

fn label(&self) -> Text

The header text.
Source§

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

The row’s value as plain text.
Source§

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

The row’s table cell.
Source§

fn column_width(&self) -> ColumnWidth

The width the column claims.
Source§

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

fn alignment(&self) -> Alignment

Where the header and the cells align their content.
Source§

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

The relations text, cell and entry read.
Source§

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. Read more
Source§

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

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

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

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

impl<M> Debug for ComputedColumn<M>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<M> IntoColumns<M> for ComputedColumn<M>
where Self: Column<M> + 'static,

Source§

impl<M> IntoDetail<M> for ComputedColumn<M>
where Self: Column<M> + 'static,

Auto Trait Implementations§

§

impl<M> !RefUnwindSafe for ComputedColumn<M>

§

impl<M> !UnwindSafe for ComputedColumn<M>

§

impl<M> Forget for ComputedColumn<M>

§

impl<M> Freeze for ComputedColumn<M>
where Arc<dyn Fn(&M) -> String + Sync + Send>: Freeze, Includes<M>: Freeze, Option<Reads<M>>: Freeze, Option<Arc<dyn Fn(&M) -> Option<Color> + Sync + Send>>: Freeze,

§

impl<M> Move for ComputedColumn<M>

§

impl<M> Send for ComputedColumn<M>
where Arc<dyn Fn(&M) -> String + Sync + Send>: Send, Includes<M>: Send, Option<Reads<M>>: Send, Option<Arc<dyn Fn(&M) -> Option<Color> + Sync + Send>>: Send,

§

impl<M> Sync for ComputedColumn<M>
where Arc<dyn Fn(&M) -> String + Sync + Send>: Sync, Includes<M>: Sync, Option<Reads<M>>: Sync, Option<Arc<dyn Fn(&M) -> Option<Color> + Sync + Send>>: Sync,

§

impl<M> Unpin for ComputedColumn<M>
where Arc<dyn Fn(&M) -> String + Sync + Send>: Unpin, Includes<M>: Unpin, Option<Reads<M>>: Unpin, Option<Arc<dyn Fn(&M) -> Option<Color> + Sync + Send>>: Unpin,

§

impl<M> UnsafeUnpin for ComputedColumn<M>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more