Skip to main content

TableState

Struct TableState 

Source
pub struct TableState {
    pub query: String,
    pub page: i32,
    /* private fields */
}
Expand description

The signals a DataTable or ServerTable keeps: filter text, page, and sort.

Put one in the page’s signals for each table. A ServerTable sends it to the server, which reads the sort with TableState::sorting.

use hypersig::Signals;
use hypersig_ui::TableState;
use serde::{Deserialize, Serialize};

#[derive(Signals, Serialize, Deserialize)]
struct Users {
    table: TableState,
}

let users = Users { table: TableState::default() };
assert_eq!(users.table.page, 0);

Fields§

§query: String

What the filter field holds.

§page: i32

The page shown, counted from 0.

Implementations§

Source§

impl TableState

Source

pub fn query() -> Sig<Self, String>

Typed reference to the query signal.

Source

pub fn page() -> Sig<Self, i32>

Typed reference to the page signal.

Source§

impl TableState

Source

pub fn sorting<K: Segment>(&self) -> Option<(K, SortOrder)>

The key of the column a ServerTable is sorted by, and its order.

Returns None while the table is unsorted, and where the sorted column is not one of K, such as for a state a DataTable wrote.

use hypersig::Segment;
use hypersig_ui::{SortOrder, TableState};
use serde::{Deserialize, Serialize};

#[derive(Segment, Serialize, Deserialize, Debug, PartialEq)]
enum By {
    Email,
    Amount,
}

let state = TableState::default().with_sorting(&By::Amount, SortOrder::Descending);
assert_eq!(state.sorting::<By>(), Some((By::Amount, SortOrder::Descending)));
assert_eq!(TableState::default().sorting::<By>(), None);
Source

pub fn with_sorting<K: Segment>(self, key: &K, order: SortOrder) -> Self

This state sorted by the ServerTable column whose key is key, in order.

Use it for the first state of a page whose server sends the rows already sorted, so that the column’s header says so.

Trait Implementations§

Source§

impl Clone for TableState

Source§

fn clone(&self) -> TableState

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() -> TableState

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

impl<'de> Deserialize<'de> for TableState

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for TableState

Source§

impl PartialEq for TableState

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for TableState

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Signals for TableState

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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> 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.