Struct CharCollection

pub struct CharCollection { /* private fields */ }

A collection of chars (i.e. Unicode code points), used for storing large continuous ranges efficiently.

Lookups and insertions are O(log R), where R is the number of disjoint ranges in the collection.

The easiest way to create instances is using the char_collect! macro.

use char_collection::CharCollection;

let mut collection: CharCollection = char_collect!('a'..='d', 'x'..='z');
char_collection += 'e';
char_collection += chars!('p'..='t');
assert_eq!(
    collection.iter_ranges().collect(),
    vec![chars!('a'..='e'), chars!('p'..='t'), chars!('x'..='z')]);

assert!(collection.contains(&'c'));
assert!(collection.contains_range(chars!('q'..='s')));
assert!(!collection.contains(&'9'));

collection -= chars!('t'..='y');
assert_eq!(
    collection.iter_ranges().collect(),
    vec![chars!('a'..='e', chars!('p'..'s'), chars!('z'..='z'))]);

TODO(kpozin): Implement IntoIter.

Implementations

impl CharCollection

pub fn new() -> CharCollection

Create a new, empty CharCollection.

pub fn from_sorted_ranges<T>(ranges: T) -> Result<CharCollection, Error>

where T: IntoIterator<Item = CharRange>,

Create a new CharCollection from a list of disjoint, non-adjacent CharRanges, pre-sorted in ascending code point order.

This factory method is primarily intended for use in deserializing valid representations of CharCollections. Will return an error if ranges are out of order, overlapping, or adjacent.

pub fn from_sorted_chars<T>(chars: T) -> Result<CharCollection, Error>

where T: IntoIterator<Item = char>,

Create a new CharCollection from a list of chars, pre-sorted in ascending code point order.

This factory method is primarily intended for use in deserializing valid representations of CharCollections. Will return an error if chars are out of order or contain duplicates.

pub fn iter(&self) -> impl Iterator<Item = char> + '_

Iterate over all the chars in the collection.

pub fn contains(&self, ch: &char) -> bool

Test whether the collection contains a specific char.

The time complexity is O(log R), where R is the number of ranges in the collection.

pub fn contains_range(&self, range: &CharRange) -> bool

Test whether the collection contains an entire range of characters.

The time complexity is O(log R), where R is the number of ranges in the collection.

pub fn insert<V: MultiCharRange>(&mut self, to_add: &V) -> &mut Self

Insert a char or other collection of chars into this collection.

Returns &mut self for easy chaining.

The time complexity is O(T log(R + T)), where R is the number of ranges in this collection and T is the number of ranges in to_add.

pub fn append(&mut self, ch: char) -> Result<&mut Self, Error>

Appends a char to the end of the existing collection. Panics if the given char is not higher than the highest code point in the existing collection.

Returns &mut self for easy chaining.

The time complexity is O(1).

pub fn append_range(&mut self, range: CharRange) -> Result<&mut Self, Error>

Appends a CharRange to the end of the existing collection. Panics if the given range is not higher than the highest code point in the existing collection. (The new range may be adjacent to the previous highest range, but may not overlap.)

Returns &mut self for easy chaining.

The time complexity is O(1).

pub fn remove<V: MultiCharRange>(&mut self, to_remove: &V) -> &mut Self

Remove a char or other collection of chars from this collection.

Returns &mut self for easy chaining.

The time complexity is O(T log(R + T)), where R is the number of ranges in this collection and T is the number of ranges in to_remove.

pub fn clear(&mut self) -> &mut Self

Remove all entries from this collection.

Returns &mut self for easy chaining.

pub fn union<V: MultiCharRange>(&self, rhs: &V) -> CharCollection

Return the set union of this collection and another one.

The time complexity is O(min(R, T) log(R + T)), where R is the number of ranges in this collection and T is the number of ranges in rhs.

pub fn intersection<V: MultiCharRange>(&self, rhs: &V) -> CharCollection

Return the set intersection of this collection and another one.

The time complexity is O(min(R, T) log(R + T)), where R is the number of ranges in this collection and T is the number of ranges in rhs.

pub fn difference<V: MultiCharRange>(&self, rhs: &V) -> CharCollection

Return the (non-symmetric) set difference of this collection and another one.

The time complexity is O(T log(R + T)), where R is the number of ranges in this collection and T is the number of ranges in rhs.

pub fn complement(&self) -> CharCollection

Return the set complement of this collection (over the universe of chars).

The time complexity is O(R), where R is the number of ranges in this collection.

Trait Implementations

impl<V: MultiCharRange> Add<V> for CharCollection

type Output = CharCollection

The resulting type after applying the + operator.

fn add(self, rhs: V) -> Self::Output

Performs the + operation.

impl<V: MultiCharRange> AddAssign<V> for CharCollection

fn add_assign(&mut self, rhs: V)

Performs the += operation.

impl<V: MultiCharRange> BitAnd<V> for CharCollection

type Output = CharCollection

The resulting type after applying the & operator.

fn bitand(self, rhs: V) -> Self::Output

Performs the & operation.

impl<V: MultiCharRange> BitAndAssign<V> for CharCollection

fn bitand_assign(&mut self, rhs: V)

Performs the &= operation.

impl<V: MultiCharRange> BitOr<V> for CharCollection

type Output = CharCollection

The resulting type after applying the | operator.

fn bitor(self, rhs: V) -> Self::Output

Performs the | operation.

impl<V: MultiCharRange> BitOrAssign<V> for CharCollection

fn bitor_assign(&mut self, rhs: V)

Performs the |= operation.

impl Clone for CharCollection

fn clone(&self) -> CharCollection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CharCollection

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

Formats the value using the given formatter.

impl Default for CharCollection

fn default() -> CharCollection

Returns the “default value” for a type.

impl<T: MultiCharRange> From<&T> for CharCollection

fn from(source: &T) -> Self

Converts to this type from the input type.

impl Hash for CharCollection

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl MultiCharRange for CharCollection

fn iter_ranges<'a>(&'a self) -> Box<dyn Iterator<Item = CharRange> + 'a>

Iterate over the disjoint, non-adjacent [CharRange]s in the collection in ascending order.

fn range_count(&self) -> usize

The number of ranges in the collection.

impl Not for CharCollection

type Output = CharCollection

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for CharCollection

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

Tests for self and other values to be equal, and is used by ==.

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<V: MultiCharRange> Sub<V> for CharCollection

type Output = CharCollection

The resulting type after applying the - operator.

fn sub(self, rhs: V) -> Self::Output

Performs the - operation.

impl<V: MultiCharRange> SubAssign<V> for CharCollection

fn sub_assign(&mut self, rhs: V)

Performs the -= operation.

impl Eq for CharCollection

impl StructuralPartialEq for CharCollection