Struct Set

pub struct Set<'a, T> { /* private fields */ }

A set of non-duplicate items.

On a high level, a Set<T> is equivalent to a Map<T, Empty>, but offers a more intuitive API similar to native HashSet and BTreeSet.

Implementations

impl<'a, T> Set<'a, T>

pub const fn new(namespace: &'a str, counter_namespace: &'static str) -> Self

Create a new instance of the item set with the given map and counter namespaces.

pub fn count(&self, store: &dyn Storage) -> StdResult<u64>

Return the total amount of items in the set.

impl<'a, T> Set<'a, T>

where T: PrimaryKey<'a> + KeyDeserialize,

pub fn contains(&self, store: &dyn Storage, item: T) -> bool

Returns true if the set contains an item

pub fn insert(&self, store: &mut dyn Storage, item: T) -> StdResult<bool>

Adds an item to the set. Returns whether the item was newly added.

pub fn remove(&self, store: &mut dyn Storage, item: T) -> StdResult<bool>

Remove an item from the set. Returns whether the item was present in the set.

impl<'a, T> Set<'a, T>

where T: PrimaryKey<'a> + KeyDeserialize,

pub fn prefix(&self, p: T::Prefix) -> Prefix<T::Suffix, Empty, T::Suffix>

Access items in the set under the given prefix.\

Copied from cw-storage-plus: https://github.com/CosmWasm/cw-plus/blob/v0.14.0/packages/storage-plus/src/map.rs#L124-126

pub fn items<'c>( &self, store: &'c dyn Storage, min: Option<Bound<'a, T>>, max: Option<Bound<'a, T>>, order: Order, ) -> Box<dyn Iterator<Item = StdResult<T::Output>> + 'c>

where T::Output: 'static,

Iterates items in the set with the specified bounds and ordering.

pub fn clear(&self, store: &mut dyn Storage)

Delete all elements from the set.

Copied from cw-storage-plus: https://github.com/CosmWasm/cw-storage-plus/blob/v0.16.0/src/map.rs#L115-L132