Struct DedupVec

pub struct DedupVec<T, const ON: bool = true>
where
    Self: AsDedupVec,
{ /* private fields */ }

Deduplicated vector.

• If ON is true, then the vector keeps sorted and deduplicated status. It means the vector will conduct sorting and binary search whenever you insert or remove items into or from the vector. In this case, Vec is used as data container.

• If ON is false, on the other hand, the vector acts differently according to build mode.

  • debug mode : Vector will panic when duplication detected. SetValueList is used as data container in this case. The container keeps insertion order.
  • release mode : Vector does nothing to keep the deduplicated status. Clients must keep the status on their code. In this case, Vec is used as data container.

How to determine ON

If sorting is not a burden to you, and you’re going to insert/remove items in any orders, then set ON to true. The vector will keep the deduplicated status always.

If you can guarantee the deduplicated status on your own, then set ON to false. The vector will warn you if the guarantee has been broken in debug mode. In release mode, there won’t be any additional operations to avoid performance penalty.

Trait Implementations

impl<T> AsDedupVec for DedupVec<T, true>

where T: Ord,

fn new() -> Self

Creates a new empty vector.

The vector will automatically sort and deduplicate items for you due to ON = true.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<i32, true>::new();

fn len(&self) -> usize

Returns number of items.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<_, true>::new();
v.push(0);
assert_eq!(v.len(), 1);

fn contains(&self, value: &Self::Item) -> bool

Returns true if the vector contains the given value.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<_, true>::new();
v.push(0);
assert!(v.contains(&0));

fn push(&mut self, value: Self::Item)

Appends the given value to the end of the vector.

The vector will automatically sort and deduplicate items for you due to ON = true.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<_, true>::new();
v.push(0);
v.push(0);
v.push(2);
v.push(1);
let dedup = v.iter().cloned().collect::<Vec<_>>();
assert_eq!(dedup, [0, 1, 2]);

fn remove(&mut self, value: &Self::Item) -> Option<Self::Item>

Removes an item that is equal to the given value from the vector.

The vector will automatically sort and deduplicate items for you due to ON = true.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<_, true>::new();
v.push(0);
v.push(2);
v.push(1);
v.remove(&1);
let dedup = v.iter().cloned().collect::<Vec<_>>();
assert_eq!(dedup, [0, 2]);

fn extend(&mut self, iter: impl IntoIterator<Item = Self::Item>)

Extends the vector with the given iterator.

The vector will automatically sort and deduplicate items for you due to ON = true.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<_, true>::new();
v.extend([0, 2, 1]);
let dedup = v.iter().cloned().collect::<Vec<_>>();
assert_eq!(dedup, [0, 1, 2]);

fn iter(&self) -> impl Iterator<Item = &Self::Item>

Returns an iterator visiting all items in the vector.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<_, true>::new();
v.push(0);
v.push(1);
for x in v.iter() {
    println!("{x}");
}

type Item = T

Vector item type.

type Container = Vec<T>

Vector type.

fn is_empty(&self) -> bool

Returns true if the vector is empty.

impl<T> AsDedupVec for DedupVec<T, false>

where T: Hash + Eq + Default + Clone,

fn new() -> Self

Creates a new empty vector.

The vector won’t do anything to keep the deduplicated status, but it panics when you insert duplicate item into the vector in debug mode due to ON = false.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<i32, false>::new();

fn len(&self) -> usize

Returns number of items.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<_, false>::new();
v.push(0);
assert_eq!(v.len(), 1);

fn contains(&self, value: &Self::Item) -> bool

Returns true if the vector contains the given value.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<_, false>::new();
v.push(0);
assert!(v.contains(&0));

fn push(&mut self, value: Self::Item)

Appends the given value to the end of the vector.

The vector won’t do anything to keep the deduplicated status, but it panics when you insert duplicate item into the vector in debug mode due to ON = false.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<_, false>::new();
v.push(0);
v.push(2);
v.push(1);
let dedup = v.iter().cloned().collect::<Vec<_>>();
assert_eq!(dedup, [0, 2, 1]);

fn remove(&mut self, value: &Self::Item) -> Option<Self::Item>

Removes an item that is equal to the given value from the vector.

The vector won’t do anything to keep the deduplicated status, but it panics when you insert duplicate item into the vector in debug mode due to ON = false.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<_, false>::new();
v.push(0);
v.push(1);
v.push(2);
v.remove(&1);
let dedup = v.iter().cloned().collect::<Vec<_>>();
assert_eq!(dedup, [0, 2]);

fn extend(&mut self, iter: impl IntoIterator<Item = Self::Item>)

Extends the vector with the given iterator.

The vector won’t do anything to keep the deduplicated status, but it panics when you insert duplicate item into the vector in debug mode due to ON = false.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<_, false>::new();
v.extend([0, 2, 1]);
let dedup = v.iter().cloned().collect::<Vec<_>>();
assert_eq!(dedup, [0, 2, 1]);

fn iter(&self) -> impl Iterator<Item = &Self::Item>

Returns an iterator visiting all items in the vector.

Examples

use my_ecs::ds::{AsDedupVec, DedupVec};

let mut v = DedupVec::<_, false>::new();
v.push(0);
v.push(1);
for x in v.iter() {
    println!("{x}");
}

type Item = T

Vector item type.

type Container = SetValueList<T, RandomState>

Vector type.

fn is_empty(&self) -> bool

Returns true if the vector is empty.

impl<T, const ON: bool> Debug for DedupVec<T, ON>

where Self: AsDedupVec, <Self as AsDedupVec>::Container: Debug,

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

Formats the value using the given formatter.

impl<T> From<DedupVec<T>> for Vec<T>

where T: Ord,

fn from(value: DedupVec<T, true>) -> Self

Converts to this type from the input type.

impl<T> From<DedupVec<T, false>> for Vec<T>

where T: Hash + Eq + Default + Clone,

fn from(value: DedupVec<T, false>) -> Self

Converts to this type from the input type.