Struct ListFilter 

#[non_exhaustive]
pub struct ListFilter {
    pub field: String,
    pub label: Text,
    pub filter_type: String,
    pub options: Value,
    pub default_value: Option<String>,
    pub permission: Option<String>,
}

One filter offered above a list: a column, its label, and what it offers.

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 control’s label, localized at render.

filter_type: String

What the filter offers: boolean, select, text, number or date.

options: Value

The keys that belong to the filter’s type, as an object: in a file they are written on the filter itself. A select carries its choices here.

default_value: Option<String>

Applied when the request names no value for this filter at all, so a screen can open already narrowed. Clearing it is still “no filter”.

permission: Option<String>

A permission the operator must hold to see this filter, and to have its default applied.

Implementations

impl ListFilter

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

A filter of any declared type, with no options.

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

A yes/no filter over a boolean column.

pub fn select( field: &str, label: impl Into<Text>, options: Vec<FilterOption>, ) -> Self

A filter offering a fixed set of values. Only a declared one reaches the query.

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

A substring match, folded the way the search box folds.

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

An exact match on a whole number.

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

Rows on one calendar day, whether the column stores a date or a timestamp.

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

The value to apply when the request names none.

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

Shown only to an operator holding permission.

Trait Implementations

impl Clone for ListFilter

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 ListFilter

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

Formats the value using the given formatter.

impl Default for ListFilter

fn default() -> Self

A text filter, named and labelled like a column.

impl<'de> Deserialize<'de> for ListFilter

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

Deserialize this value from the given Serde deserializer.

impl Serialize for ListFilter

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

Serialize this value into the given Serde serializer.