Skip to main content

TableState

Struct TableState 

Source
pub struct TableState {
    pub prefix: Option<String>,
    pub search: Option<String>,
    pub sort: Option<Sort>,
    pub cursor: Option<Cursor>,
    pub filters: BTreeMap<String, String>,
    pub filters_dropped: bool,
    pub group_by: Option<String>,
    pub delete: Option<String>,
    pub open: Option<bool>,
}
Expand description

Request-scoped table state, parsed from the list’s URL query.

Fields§

§prefix: Option<String>

The prefix every parameter of this table carries, or None for a page’s own list.

§search: Option<String>

?q= — trimmed and clamped to MAX_QUERY_TERM chars; None when absent or blank.

§sort: Option<Sort>

?sort= + ?dir= — None when absent or blank.

§cursor: Option<Cursor>

?after= or ?before=.

§filters: BTreeMap<String, String>

?f.<name>=<value>, one parameter per active filter, by name. A blank value is no filter.

§filters_dropped: bool

Filter parameters the parse dropped.

§group_by: Option<String>

?group_by= — field name to group by (in-memory, count summarizer).

§delete: Option<String>

?delete= — the row key whose delete dialog opens; never a write.

§open: Option<bool>

?open=false — renders the delete dialog closed.

Implementations§

Source§

impl TableState

Source

pub fn from_cx(cx: &Cx) -> Self

Parse the state from the request in cx: Self::from_query over the request URI’s query. Renders without a request context (e.g. unit tests) get neutral state.

Source

pub fn from_cx_prefixed(cx: &Cx, prefix: &str) -> Self

Self::from_cx for the table whose parameters carry prefix, on a page of several.

Source

pub fn from_query_prefixed(query: &str, prefix: &str) -> Self

Self::from_query for the table whose parameters carry prefix: only the parameters spelled {prefix}.{name} are read, as name, and the parsed state carries the prefix so its links spell the same names.

Source

pub fn from_query(query: &str) -> Self

Parse the state from a URL query (without the leading ?): the one parser behind the GET page and the live shard.

A blank or unknown query parses as neutral state rather than failing the request. A duplicate key keeps its first occurrence, so a repeated filter never vanishes. A blank or dropped filter occurrence is no filter, so a later occurrence of the same filter applies (a dropped one still flags Self::filters_dropped). q is trimmed and clamped to MAX_QUERY_TERM, dir is trimmed before comparing, and at most MAX_FILTERS filters of at most MAX_FILTER_LEN bytes apply. A cursor token is checked later, when it decodes.

The live shard parses a client-owned query, so the parse is linear in its length: only the known keys are remembered.

Trait Implementations§

Source§

impl Clone for TableState

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

Source§

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

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

impl Default for TableState

Source§

fn default() -> Self

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

impl Eq for TableState

Source§

impl PartialEq for TableState

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TableState

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<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> CloneAny for T
where T: Any + Clone,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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