Struct ActixAdminModelFilter 

pub struct ActixAdminModelFilter<E: EntityTrait> {
    pub name: String,
    pub filter_type: ActixAdminModelFilterType,
    pub filter: FilterFn<E>,
    pub values: Option<Vec<(String, String)>>,
    pub foreign_key: Option<String>,
    pub operators: Vec<ActixAdminFilterOperator>,
}

A single filter registered on an entity via ActixAdminModelFilterTrait.

The filter closure receives the current query, the user-provided value (a plain Option<String>) and — when the filter opted into operator selection — the operator picked in the UI.

Fields

name: String

filter_type: ActixAdminModelFilterType

filter: FilterFn<E>

Underlying filter callback (value-only or operator-aware).

values: Option<Vec<(String, String)>>

foreign_key: Option<String>

operators: Vec<ActixAdminFilterOperator>

Operators the user may pick from. When empty, no operator selector is rendered and operator-aware filters receive None.

Implementations

impl<E: EntityTrait> ActixAdminModelFilter<E>

pub fn new( name: impl Into<String>, filter_type: ActixAdminModelFilterType, filter: fn(Select<E>, Option<String>) -> Select<E>, ) -> Self

Build a value-only filter. The closure receives the current query plus the user-typed value; operator information is not surfaced.

pub fn with_op( name: impl Into<String>, filter_type: ActixAdminModelFilterType, filter: fn(Select<E>, Option<String>, Option<ActixAdminFilterOperator>) -> Select<E>, ) -> Self

Build an operator-aware filter. The closure additionally receives the operator the user picked in the UI (if any).

pub fn with_operators(self, operators: Vec<ActixAdminFilterOperator>) -> Self

pub fn with_operator_filter( self, f: fn(Select<E>, Option<String>, Option<ActixAdminFilterOperator>) -> Select<E>, ) -> Self

Replace the filter callback with an operator-aware one.

Kept for backwards compatibility — new code should use Self::with_op directly.

pub fn with_foreign_key(self, fk: impl Into<String>) -> Self

pub fn with_values(self, values: Vec<(String, String)>) -> Self

Trait Implementations

impl<T: EntityTrait> From<ActixAdminModelFilter<T>> for ActixAdminViewModelFilter

fn from(filter: ActixAdminModelFilter<T>) -> Self

Converts to this type from the input type.