Struct subset::multi::Subset

pub struct Subset<'a, T> { /* fields omitted */ }

Multi-subset of slice's items that is able to iterate forward and backward over references to selected items. Each item of a slice can be selected more than once.

The only difference between Subset and SubsetMut is that Subset holds immutable reference to original set.

Methods

impl<'a, T> Subset<'a, T>

pub fn new(set: &'a [T], idxs: &'a [usize]) -> Result<Self, SubsetError>

Constructs a multi-subset from the whole set and indexes of the selected items. Array bounds is checked. Note that subsets are not designed for ZSTs.

Examples

let set = [1, 2, 3];
let idxs = [0, 1];
let subset = Subset::new(&set, &idxs).unwrap();

Errors

OutOfBounds, if any index is >= set.len()

Panics

Panics if std::mem::size_of::<T>() == 0

pub unsafe fn new_unchecked(set: &'a [T], idxs: &'a [usize]) -> Self

Constructs a multi-subset from the whole set and indexes of the selected items. No array bounds check.

pub fn set(&self) -> &[T]

Returns the original slice.

pub fn idxs(&self) -> &[usize]

Returns indexes of selected items.

pub fn is_unique(&self) -> bool

Checks that no items are selected twice or more. if is_unique() == true then subset can be converted to unique::Subset.

Examples

 
let set = ["one", "two", "three"];
let idxs = [0, 1];
let subset = Subset::new(&set, &idxs).unwrap();
if subset.is_unique() {
    let uniq_subset: subset::unique::Subset<_> = subset.try_into().unwrap();
}

pub unsafe fn to_unique_unchecked(self) -> Subset<'a, T>

Converts to subset::unique::Subset. Uniqueness of indexes is not checked.

Important traits for Iter<'a, T>

impl<'a, T: 'a> Iterator for Iter<'a, T> type Item = &'a T;

pub fn iter(&self) -> Iter<T>

Returns an iterator over immutable references to selected items.

Trait Implementations

impl<'a, T> IntoIterator for &'a Subset<'a, T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

Important traits for Iter<'a, T>

impl<'a, T: 'a> Iterator for Iter<'a, T> type Item = &'a T;

fn into_iter(self) -> Iter<'a, T>

Creates an iterator from a value.

impl<'a, T> From<SubsetMut<'a, T>> for Subset<'a, T>

fn from(s: SubsetMut<'a, T>) -> Self

Performs the conversion.

impl<'a, T> From<Subset<'a, T>> for Subset<'a, T>

fn from(s: Subset<T>) -> Subset<T>

Performs the conversion.

impl<'a, T> From<SubsetMut<'a, T>> for Subset<'a, T>

fn from(s: SubsetMut<T>) -> Subset<T>

Performs the conversion.

impl<'a, T: Debug> Debug for Subset<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> TryFrom<Subset<'a, T>> for Subset<'a, T>

type Error = SubsetError

The type returned in the event of a conversion error.

fn try_from(s: Subset<'a, T>) -> Result<Self, SubsetError>

Performs the conversion.