Struct gtk4::Bitset

pub struct Bitset(_);

A Bitset represents a set of unsigned integers.

Another name for this data structure is “bitmap”.

The current implementation is based on roaring bitmaps.

A bitset allows adding a set of integers and provides support for set operations like unions, intersections and checks for equality or if a value is contained in the set. Bitset also contains various functions to query metadata about the bitset, such as the minimum or maximum values or its size.

The fastest way to iterate values in a bitset is BitsetIter.

The main use case for Bitset is implementing complex selections for SelectionModel.

Implementations

impl Bitset

pub fn new_empty() -> Bitset

Creates a new empty bitset.

Returns

A new empty bitset

pub fn new_range(start: u32, n_items: u32) -> Bitset

Creates a bitset with the given range set.

start

first value to add

n_items

number of consecutive values to add

Returns

A new bitset

pub fn add(&self, value: u32) -> bool

Adds value to self if it wasn’t part of it before.

value

value to add

Returns

true if value was not part of self and self was changed

pub fn add_range(&self, start: u32, n_items: u32)

Adds all values from start (inclusive) to start + n_items (exclusive) in self.

start

first value to add

n_items

number of consecutive values to add

pub fn add_range_closed(&self, first: u32, last: u32)

Adds the closed range [first, last], so first, last and all values in between. first must be smaller than last.

first

first value to add

last

last value to add

pub fn add_rectangle(&self, start: u32, width: u32, height: u32, stride: u32)

Interprets the values as a 2-dimensional boolean grid with the given stride and inside that grid, adds a rectangle with the given width and height.

start

first value to add

width

width of the rectangle

height

height of the rectangle

stride

row stride of the grid

pub fn contains(&self, value: u32) -> bool

Checks if the given value has been added to self

value

the value to check

Returns

true if self contains value

pub fn copy(&self) -> Option<Bitset>

Creates a copy of self.

Returns

A new bitset that contains the same values as self

pub fn difference(&self, other: &Bitset)

Sets self to be the symmetric difference of self and other.

The symmetric difference is set self to contain all values that were either contained in self or in other, but not in both. This operation is also called an XOR.

It is allowed for self and other to be the same bitset. The bitset will be emptied in that case.

other

the Bitset to compute the difference from

pub fn equals(&self, other: &Bitset) -> bool

Returns true if self and other contain the same values.

other

another Bitset

Returns

true if self and other contain the same values

pub fn maximum(&self) -> u32

Returns the largest value in self.

If self is empty, 0 is returned.

Returns

The largest value in self

pub fn minimum(&self) -> u32

Returns the smallest value in self.

If self is empty, G_MAXUINT is returned.

Returns

The smallest value in self

pub fn nth(&self, nth: u32) -> u32

Returns the value of the nth item in self.

If nth is >= the size of self, 0 is returned.

nth

index of the item to get

Returns

the value of the nth item in self

pub fn size(&self) -> u64

Gets the number of values that were added to the set.

For example, if the set is empty, 0 is returned.

Note that this function returns a guint64, because when all values are set, the return value is G_MAXUINT + 1. Unless you are sure this cannot happen (it can’t with GListModel), be sure to use a 64bit type.

Returns

The number of values in the set.

pub fn size_in_range(&self, first: u32, last: u32) -> u64

Gets the number of values that are part of the set from first to last (inclusive).

Note that this function returns a guint64, because when all values are set, the return value is G_MAXUINT + 1. Unless you are sure this cannot happen (it can’t with GListModel), be sure to use a 64bit type.

first

the first element to include

last

the last element to include

Returns

The number of values in the set from first to last.

pub fn intersect(&self, other: &Bitset)

Sets self to be the intersection of self and other.

In other words, remove all values from self that are not part of other.

It is allowed for self and other to be the same bitset. Nothing will happen in that case.

other

the Bitset to intersect with

pub fn is_empty(&self) -> bool

Check if no value is contained in bitset.

Returns

true if self is empty

pub fn remove(&self, value: u32) -> bool

Removes value from self if it was part of it before.

value

value to add

Returns

true if value was part of self and self was changed

pub fn remove_all(&self)

Removes all values from the bitset so that it is empty again.

pub fn remove_range(&self, start: u32, n_items: u32)

Removes all values from start (inclusive) to start + n_items (exclusive) in self.

start

first value to remove

n_items

number of consecutive values to remove

pub fn remove_range_closed(&self, first: u32, last: u32)

Removes the closed range [first, last], so first, last and all values in between. first must be smaller than last.

first

first value to remove

last

last value to remove

pub fn remove_rectangle(&self, start: u32, width: u32, height: u32, stride: u32)

Interprets the values as a 2-dimensional boolean grid with the given stride and inside that grid, removes a rectangle with the given width and height.

start

first value to remove

width

width of the rectangle

height

height of the rectangle

stride

row stride of the grid

pub fn shift_left(&self, amount: u32)

Shifts all values in self to the left by amount.

Values smaller than amount are discarded.

amount

amount to shift all values to the left

pub fn shift_right(&self, amount: u32)

Shifts all values in self to the right by amount.

Values that end up too large to be held in a guint are discarded.

amount

amount to shift all values to the right

pub fn splice(&self, position: u32, removed: u32, added: u32)

This is a support function for GListModel handling, by mirroring the GlistModel::items-changed signal.

First, it “cuts” the values from position to removed from the bitset. That is, it removes all those values and shifts all larger values to the left by removed places.

Then, it “pastes” new room into the bitset by shifting all values larger than position by added spaces to the right. This frees up space that can then be filled.

position

position at which to slice

removed

number of values to remove

added

number of values to add

pub fn subtract(&self, other: &Bitset)

Sets self to be the subtraction of other from self.

In other words, remove all values from self that are part of other.

It is allowed for self and other to be the same bitset. The bitset will be emptied in that case.

other

the Bitset to subtract

pub fn union(&self, other: &Bitset)

Sets self to be the union of self and other.

That is, add all values from other into self that weren’t part of it.

It is allowed for self and other to be the same bitset. Nothing will happen in that case.

other

the Bitset to union with

Trait Implementations

impl Clone for Bitset

fn clone(&self) -> Bitset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bitset

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

Formats the value using the given formatter.

impl Hash for Bitset

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Bitset

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Bitset> for Bitset

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

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

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

This method tests for !=.

impl PartialOrd<Bitset> for Bitset

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for Bitset

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Bitset

impl StructuralEq for Bitset

impl StructuralPartialEq for Bitset