Struct ListStore

pub struct ListStore { /* private fields */ }

GListStore is a simple implementation of ListModel that stores all items in memory.

It provides insertions, deletions, and lookups in logarithmic time with a fast path for the common case of iterating the list linearly.

Properties

item-type

The type of items contained in this list store. Items must be subclasses of #GObject.

Readable | Writeable | Construct Only

n-items

The number of items contained in this list store.

Readable

Implements

[trait@glib::ObjectExt], ListModelExt, ListModelExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl ListStore

pub fn new<T: IsA<Object>>() -> Self

Creates a new #GListStore with items of type @item_type. @item_type must be a subclass of #GObject.

item_type

the #GType of items in the list

Returns

a new #GListStore

pub fn with_type(type_: Type) -> Self

pub fn insert_sorted<P: IsA<Object>, F: FnMut(&Object, &Object) -> Ordering>( &self, item: &P, compare_func: F, ) -> u32

Inserts @item into @self at a position to be determined by the @compare_func.

The list must already be sorted before calling this function or the result is undefined. Usually you would approach this by only ever inserting items by way of this function.

This function takes a ref on @item.

item

the new item

compare_func

pairwise comparison function for sorting

Returns

the position at which @item was inserted

pub fn sort<F: FnMut(&Object, &Object) -> Ordering>(&self, compare_func: F)

Sort the items in @self according to @compare_func.

compare_func

pairwise comparison function for sorting

pub fn splice( &self, position: u32, n_removals: u32, additions: &[impl IsA<Object>], )

Changes @self by removing @n_removals items and adding @n_additions items to it. @additions must contain @n_additions items of type #GListStore:item-type. None is not permitted.

This function is more efficient than g_list_store_insert() and g_list_store_remove(), because it only emits #GListModel::items-changed once for the change.

This function takes a ref on each item in @additions.

The parameters @position and @n_removals must be correct (ie: @position + @n_removals must be less than or equal to the length of the list at the time this function is called).

position

the position at which to make the change

n_removals

the number of items to remove

additions

the items to add

pub fn extend_from_slice(&self, additions: &[impl IsA<Object>])

Appends all elements in a slice to the ListStore.

pub fn retain(&self, f: impl FnMut(&Object) -> bool)

Retains only the elements specified by the predicate. This method operates in place, visiting each element exactly once in the original order, and preserves the order of the retained elements. Because the elements are visited exactly once in the original order, external state may be used to decide which elements to keep.

Panics

Panics if the predicate closure mutates the list by removing or adding items.

pub fn find_with_equal_func<F: FnMut(&Object) -> bool>( &self, equal_func: F, ) -> Option<u32>

Available on crate feature v2_74 only.

Looks up the given @item in the list store by looping over the items and comparing them with @equal_func until the first occurrence of @item which matches. If @item was not found, then @position will not be set, and this method will return false.

@item is always passed as second parameter to @equal_func.

Since GLib 2.76 it is possible to pass NULL for @item.

item

an item

equal_func

A custom equality check function

Returns

Whether @self contains @item. If it was found, @position will be set to the position where @item occurred for the first time.

position

the first position of @item, if it was found.

impl ListStore

pub fn builder() -> ListStoreBuilder

Creates a new builder-pattern struct instance to construct ListStore objects.

This method returns an instance of ListStoreBuilder which can be used to create ListStore objects.

pub fn append(&self, item: &impl IsA<Object>)

Appends @item to @self. @item must be of type #GListStore:item-type.

This function takes a ref on @item.

Use g_list_store_splice() to append multiple items at the same time efficiently.

item

the new item

pub fn find(&self, item: &impl IsA<Object>) -> Option<u32>

Available on crate feature v2_64 only.

Looks up the given @item in the list store by looping over the items until the first occurrence of @item. If @item was not found, then @position will not be set, and this method will return false.

If you need to compare the two items with a custom comparison function, use g_list_store_find_with_equal_func() with a custom #GEqualFunc instead.

item

an item

Returns

Whether @self contains @item. If it was found, @position will be set to the position where @item occurred for the first time.

position

the first position of @item, if it was found.

pub fn insert(&self, position: u32, item: &impl IsA<Object>)

Inserts @item into @self at @position. @item must be of type #GListStore:item-type or derived from it. @position must be smaller than the length of the list, or equal to it to append.

This function takes a ref on @item.

Use g_list_store_splice() to insert multiple items at the same time efficiently.

position

the position at which to insert the new item

item

the new item

pub fn remove(&self, position: u32)

Removes the item from @self that is at @position. @position must be smaller than the current length of the list.

Use g_list_store_splice() to remove multiple items at the same time efficiently.

position

the position of the item that is to be removed

pub fn remove_all(&self)

Removes all items from @self.

Trait Implementations

impl Clone for ListStore

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for ListStore

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

Formats the value using the given formatter.

impl<A: AsRef<Object>> Extend<A> for ListStore

fn extend<T: IntoIterator<Item = A>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<P: IsA<Object>> FromIterator<P> for ListStore

fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> Self

Creates a value from an iterator.

impl HasParamSpec for ListStore

type ParamSpec = ParamSpecObject

type SetValue = ListStore

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, ListStore>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ListStore

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterator for &'a ListStore

type Item = <&'a ListModel as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'a ListModel as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for ListStore

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for ListStore

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for ListStore

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

impl<OT: ObjectType> PartialOrd<OT> for ListStore

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ListStore

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ListStore

impl IsA<ListModel> for ListStore