Struct dioxus_sortable::UseSorter

pub struct UseSorter<'a, F: 'static> { /* private fields */ }

Stores Dioxus hooks and state of our sortable items.

Implementations

impl<'a, F> UseSorter<'a, F>

pub fn get_state(&self) -> (&F, &Direction)

Returns the current field and direction. Can be used to recreate state with UseSorterBuilder.

pub fn toggle_field(&self, field: F)where F: Sortable,

Sets the sort field and toggles the direction (if applicable). Ignores unsortable fields.

pub fn set_field(&self, field: F, dir: Direction)where F: Sortable,

Sets the sort field and direction state directly. Ignores unsortable fields. Ignores the direction if not valid for a field.

pub fn sort<T>(&self, items: &mut [T])where F: PartialOrdBy<T> + Sortable,

Sorts items according to the current field and direction.

This is not a hook and may be called conditionally. For example:

• If data is coming from a use_future then you can call this fn once it has completed.
• If you need to apply a filter, do so before calling this fn.

Trait Implementations

impl<'a, F: Clone + 'static> Clone for UseSorter<'a, F>

fn clone(&self) -> UseSorter<'a, F>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, F: Debug + 'static> Debug for UseSorter<'a, F>

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

Formats the value using the given formatter.

impl<'a, F: PartialEq + 'static> PartialEq<UseSorter<'a, F>> for UseSorter<'a, F>

fn eq(&self, other: &UseSorter<'a, F>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, F: Copy + 'static> Copy for UseSorter<'a, F>

impl<'a, F: 'static> StructuralPartialEq for UseSorter<'a, F>