Struct arcdps_imgui::TableSortSpecsMut

source ·
pub struct TableSortSpecsMut<'ui>(/* private fields */);
Expand description

A wrapper around table sort specs.

To use this simply, use conditional_sort and provide a closure – if you should sort your data, then the closure will be ran and imgui will be informed that your data is sorted.

For manual control (such as if sorting can fail), use should_sort to check if you should sort your data, sort your data using specs for information on how to sort it, and then set_sorted to indicate that the data is sorted.

Implementations§

source§

impl TableSortSpecsMut<'_>

source

pub fn specs(&self) -> Specs<'_>

Gets the specs for a given sort. In most scenarios, this will be a slice of 1 entry.

source

pub fn should_sort(&self) -> bool

Returns true if the data should be sorted.

source

pub fn set_sorted(&mut self)

Sets the internal flag that the data has been sorted.

source

pub fn conditional_sort(self, f: impl FnMut(Specs<'_>))

Provide a closure, which will receive the Specs for a sort.

If you should sort the data, the closure will run, and ImGui will be told that the data has been sorted.

If you need manual control over sorting, consider using should_sort, specs, and set_sorted youself.

Auto Trait Implementations§

§

impl<'ui> Freeze for TableSortSpecsMut<'ui>

§

impl<'ui> !RefUnwindSafe for TableSortSpecsMut<'ui>

§

impl<'ui> !Send for TableSortSpecsMut<'ui>

§

impl<'ui> !Sync for TableSortSpecsMut<'ui>

§

impl<'ui> Unpin for TableSortSpecsMut<'ui>

§

impl<'ui> !UnwindSafe for TableSortSpecsMut<'ui>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.