Struct dioxus_sortable::UseSorterBuilder

pub struct UseSorterBuilder<F> { /* private fields */ }

Builder for UseSorter. Use this to specify the field and direction of the sorter. For example by passing sort state from URL parameters.

Ordering of Self::with_field and Self::with_direction matters as the builder will ignore invalid combinations specified by the field’s Sortable. This is to prevent the user from specifying a direction that is not allowed by the field.

Implementations

impl<F: Copy + Default + Sortable> UseSorterBuilder<F>

pub fn with_field(&self, field: F) -> Self

Optionally sets the initial field to sort by.

pub fn with_direction(&self, direction: Direction) -> Self

Optionally sets the initial direction to sort by.Direction::Ascending can be set.

pub fn use_sorter(self, cx: &ScopeState) -> UseSorter<'_, F>

Creates Dioxus hooks to manage state. Must follow Dioxus hook rules and be called unconditionally in the same order as other hooks. See use_sorter() for simple usage.

This fn (or Self::use_sorter) must be called or never used. See the docs on UseSorter::sort on using conditions.

If the field or direction has not been set then the default values will be used.

Trait Implementations

impl<F: Clone> Clone for UseSorterBuilder<F>

fn clone(&self) -> UseSorterBuilder<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for UseSorterBuilder<F>

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

Formats the value using the given formatter.

impl<F: Default + Sortable> Default for UseSorterBuilder<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: PartialEq> PartialEq<UseSorterBuilder<F>> for UseSorterBuilder<F>

fn eq(&self, other: &UseSorterBuilder<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<F: Copy> Copy for UseSorterBuilder<F>

impl<F> StructuralPartialEq for UseSorterBuilder<F>