Skip to main content

PaginationState

yew_datatable::prelude

Struct PaginationState 

Source 
pub struct PaginationState { /* private fields */ }
Expand description

Complete pagination state for the table.

Tracks the current page, page size, available options, and provides navigation methods.

Implementations§

Source§

impl PaginationState

Source

pub const DEFAULT_PAGE_SIZE: usize = 10

Default page size.

Source

pub const DEFAULT_PAGE_SIZE_OPTIONS: &'static [usize]

Default page size options.

Source

pub fn new() -> PaginationState

Creates a new pagination state with default settings.

§Returns
  • PaginationState: A new pagination state with page size 10 and enabled.
Source

pub fn disabled() -> PaginationState

Creates a disabled pagination state.

§Returns
  • PaginationState: A new disabled pagination state.
Source

pub fn with_page_size(self, size: usize) -> PaginationState

Sets the page size.

§Parameters
  • size: The number of rows per page (minimum 1).
§Returns
  • Self: The modified pagination state.
Source

pub fn with_page_size_options(self, options: Vec<usize>) -> PaginationState

Sets the page size options.

§Parameters
  • options: The available page size options.
§Returns
  • Self: The modified pagination state.
Source

pub fn with_mode(self, mode: PaginationMode) -> PaginationState

Sets the pagination mode.

§Parameters
  • mode: The pagination mode (client or server).
§Returns
  • Self: The modified pagination state.
Source

pub fn with_total_rows(self, total: usize) -> PaginationState

Sets the total row count (for server-side pagination).

§Parameters
  • total: The total number of rows on the server.
§Returns
  • Self: The modified pagination state.
Source

pub fn is_enabled(&self) -> bool

Returns whether pagination is enabled.

§Returns
  • bool: Whether pagination is enabled.
Source

pub fn page_index(&self) -> usize

Returns the current page index (0-based).

§Returns
  • usize: The zero-based page index.
Source

pub fn page_number(&self) -> usize

Returns the current page number (1-based).

§Returns
  • usize: The one-based page number.
Source

pub fn page_size(&self) -> usize

Returns the page size.

§Returns
  • usize: The number of rows per page.
Source

pub fn mode(&self) -> PaginationMode

Returns the pagination mode.

§Returns
  • PaginationMode: The current pagination mode.
Source

pub fn page_size_options(&self) -> &[usize]

Returns the page size options.

§Returns
  • &[usize]: A slice of available page size options.
Source

pub fn page_count(&self, row_count: usize) -> usize

Calculates the total number of pages.

§Parameters
  • row_count: The number of rows to paginate.
§Returns
  • usize: The total number of pages (minimum 1).
Source

pub fn start_index(&self) -> usize

Returns the start index for the current page.

§Returns
  • usize: The zero-based start row index.
Source

pub fn end_index(&self, row_count: usize) -> usize

Returns the end index for the current page (exclusive).

§Parameters
  • row_count: The total number of rows.
§Returns
  • usize: The exclusive end row index.
Source

pub fn row_range(&self, row_count: usize) -> Range<usize>

Returns the range of row indices for the current page.

§Parameters
  • row_count: The total number of rows.
§Returns
  • Range<usize>: The range of row indices.
Source

pub fn can_go_previous(&self) -> bool

Returns whether there is a previous page.

§Returns
  • bool: Whether navigation to a previous page is possible.
Source

pub fn can_go_next(&self, row_count: usize) -> bool

Returns whether there is a next page.

§Parameters
  • row_count: The total number of rows.
§Returns
  • bool: Whether navigation to a next page is possible.
Source

pub fn go_to_first(&mut self)

Goes to the first page.

Source

pub fn go_to_last(&mut self, row_count: usize)

Goes to the last page.

§Parameters
  • row_count: The total number of rows.
Source

pub fn go_to_previous(&mut self)

Goes to the previous page.

Source

pub fn go_to_next(&mut self, row_count: usize)

Goes to the next page.

§Parameters
  • row_count: The total number of rows.
Source

pub fn go_to_page(&mut self, index: usize, row_count: usize)

Goes to a specific page (0-based index).

§Parameters
  • index: The zero-based page index to navigate to.
  • row_count: The total number of rows.
Source

pub fn set_page_size(&mut self, size: usize, row_count: usize)

Sets the page size and adjusts the current page if needed.

§Parameters
  • size: The new page size.
  • row_count: The total number of rows.
Source

pub fn set_total_rows(&mut self, total: usize)

Sets the total row count (for server-side pagination).

§Parameters
  • total: The total number of rows on the server.
Source

pub fn enable(&mut self)

Enables pagination.

Source

pub fn disable(&mut self)

Disables pagination.

Source

pub fn reset(&mut self)

Resets to initial state.

Trait Implementations§

Source§

impl Clone for PaginationState

Source§

fn clone(&self) -> PaginationState

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PaginationState

Source§

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

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

impl Default for PaginationState

Provides a default pagination state with standard settings.

Source§

fn default() -> PaginationState

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

impl PartialEq for PaginationState

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for PaginationState

Source§

impl StructuralPartialEq for PaginationState

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

Source§

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

Checks if this value is equivalent to the given key. 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> IntoPropValue<Option<T>> for T

Source§

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.
Source§

impl<T> IntoPropValue<T> for T

Source§

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.
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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
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
Source§

impl<Token, Builder, How> AllPropsFor<Builder, How> for Token
where Builder: Buildable<Token>, <Builder as Buildable<Token>>::WrappedToken: HasAllProps<<Builder as Buildable<Token>>::Output, How>,

Source§

impl<T> HasAllProps<(), T> for T