Skip to main content

ListOpts

Struct ListOpts 

Source
pub struct ListOpts {
    pub ordering: Vec<(String, SortDir)>,
    pub filters: Vec<(String, String)>,
    pub date_ranges: Vec<(String, Option<String>, Option<String>)>,
    pub multi_filters: Vec<(String, Vec<String>)>,
    pub search: Option<(String, Vec<String>)>,
    pub search_index_column: Option<&'static str>,
    pub limit: Option<i64>,
    pub offset: Option<i64>,
}
Expand description

Per-request options for [AdminOps::list]. Empty / None fields mean “framework default”: no ordering override falls back to id DESC inside the runtime, no filters skips the WHERE clause, no limit fetches every row.

Fields§

§ordering: Vec<(String, SortDir)>

Validated (column, dir) pairs to apply as ORDER BY. The column name is bound to the model’s M::COLUMNS set inside the runtime, so callers can pass user-supplied names without SQL-injection risk.

§filters: Vec<(String, String)>

(column, value) pairs applied as WHERE col::text = $N. Cast to text so the comparison matches the same string-shape semantics the in-memory pre-P10 filter used for bool / int / timestamp columns.

§date_ranges: Vec<(String, Option<String>, Option<String>)>

Date-range filters surfaced from super::filters::FilterKind::DateRange: each tuple is (column, gte, lte) with YYYY-MM-DD strings. Either bound may be None (open-ended). The runtime renders WHERE col::date >= $N::date and / or WHERE col::date <= $N::date. Column names are validated against M::COLUMNS; the date strings are passed through to Postgres which rejects malformed inputs.

§multi_filters: Vec<(String, Vec<String>)>

Multi-select filters surfaced from super::filters::FilterKind::MultiSelect: each tuple is (column, values) and renders as WHERE col::text IN ($N, $N+1, …). An empty values list is silently skipped — “nothing selected” should not collapse the query to an empty result. Column names are validated against M::COLUMNS; the caller is responsible for restricting values to the field’s declared choices.

§search: Option<(String, Vec<String>)>

Free-text search: (term, columns). The runtime emits WHERE (col1::text ILIKE $N OR col2::text ILIKE $N OR …) with $N = '%term%'. An empty term or empty columns leaves the WHERE alone.

§search_index_column: Option<&'static str>

When Some(col), the search WHERE clause uses Postgres FTS against this tsvector column (<col> @@ websearch_to_tsquery('english', $N)) instead of the ILIKE OR-loop above. search must still carry the raw term; the columns slice is ignored on this path. Sourced from AdminEntry::search_index_column.

§limit: Option<i64>

LIMIT $N for the data query. The COUNT(*) query never applies it. None → no limit.

§offset: Option<i64>

OFFSET $N for the data query. None or Some(0) → no offset.

Trait Implementations§

Source§

impl Clone for ListOpts

Source§

fn clone(&self) -> ListOpts

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 Debug for ListOpts

Source§

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

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

impl Default for ListOpts

Source§

fn default() -> ListOpts

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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<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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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