Struct byte_set::ByteSet

#[repr(transparent)]pub struct ByteSet(_);

An efficient, general-purpose set of u8s.

Implementation

This is a 256-bit mask where a byte is contained based on whether its bit is enabled. The first (least significant) bit in the mask represents the first byte in the set. Likewise, the last last (most significant) bit represents the last byte.

The mask is composed a of "chunk" array. Each chunk is either 64 or 32 bits wide, depending on the target architecture. As of right now, this is based on native register size. This may change in the future based on target features that enable better performance.

Implementations

impl ByteSet

#[must_use]pub const fn new() -> Self

Returns a set containing no bytes.

#[must_use]pub const fn full() -> Self

Returns a set containing all bytes (0-255).

pub fn rand<R: RngCore>(rng: R) -> Self

This is supported on feature="rand" or feature="rand_core" only.

Returns a set containing uniformly-distributed random bytes from rng.

This uses fill_bytes under the hood.

pub fn try_rand<R: RngCore>(rng: R) -> Result<Self, Error>

This is supported on feature="rand" or feature="rand_core" only.

Returns a set containing uniformly-distributed random bytes from rng, or Err if rng failed.

This uses try_fill_bytes under the hood.

pub const ASCII: Self

The set of all ASCII characters: U+0000 NULL ..= U+007F DELETE.

Examples

This contains all bytes for which u8::is_ascii returns true:

for byte in ByteSet::ASCII {
    assert!(byte.is_ascii());
}

for byte in !ByteSet::ASCII {
    assert!(!byte.is_ascii());
}

pub const ASCII_ALPHABETIC: Self

The set of all ASCII alphabetic characters:

• U+0041 'A' ..= U+005A 'Z'
• U+0061 'a' ..= U+007A 'z'

Examples

This contains all bytes for which u8::is_ascii_alphabetic returns true:

for byte in ByteSet::ASCII_ALPHABETIC {
    assert!(byte.is_ascii_alphabetic());
}

for byte in !ByteSet::ASCII_ALPHABETIC {
    assert!(!byte.is_ascii_alphabetic());
}

pub const ASCII_UPPERCASE: Self

The set of all ASCII uppercase characters: U+0041 'A' ..= U+005A 'Z'.

Examples

This contains all bytes for which u8::is_ascii_uppercase returns true:

for byte in ByteSet::ASCII_UPPERCASE {
    assert!(byte.is_ascii_uppercase());
}

for byte in !ByteSet::ASCII_UPPERCASE {
    assert!(!byte.is_ascii_uppercase());
}

pub const ASCII_LOWERCASE: Self

The set of all ASCII lowercase characters: U+0061 'a' ..= U+007A 'z'.

Examples

This contains all bytes for which u8::is_ascii_lowercase returns true:

for byte in ByteSet::ASCII_LOWERCASE {
    assert!(byte.is_ascii_lowercase());
}

for byte in !ByteSet::ASCII_LOWERCASE {
    assert!(!byte.is_ascii_lowercase());
}

pub const ASCII_ALPHANUMERIC: Self

The set of all ASCII alphanumeric characters:

• U+0041 'A' ..= U+005A 'Z'
• U+0061 'a' ..= U+007A 'z'
• U+0030 '0' ..= U+0039 '9'

Examples

This contains all bytes for which u8::is_ascii_alphanumeric returns true:

for byte in ByteSet::ASCII_ALPHANUMERIC {
    assert!(byte.is_ascii_alphanumeric());
}

for byte in !ByteSet::ASCII_ALPHANUMERIC {
    assert!(!byte.is_ascii_alphanumeric());
}

pub const ASCII_DIGIT: Self

The set of all ASCII decimal digits: U+0030 '0' ..= U+0039 '9'.

Examples

This contains all bytes for which u8::is_ascii_digit returns true:

for byte in ByteSet::ASCII_DIGIT {
    assert!(byte.is_ascii_digit());
}

for byte in !ByteSet::ASCII_DIGIT {
    assert!(!byte.is_ascii_digit());
}

pub const ASCII_HEXDIGIT: Self

The set of all ASCII hexadecimal digits:

• U+0030 '0' ..= U+0039 '9'
• U+0041 'A' ..= U+0046 'F'
• U+0061 'a' ..= U+0066 'f'

Examples

This contains all bytes for which u8::is_ascii_hexdigit returns true:

for byte in ByteSet::ASCII_HEXDIGIT {
    assert!(byte.is_ascii_hexdigit());
}

for byte in !ByteSet::ASCII_HEXDIGIT {
    assert!(!byte.is_ascii_hexdigit());
}

pub const ASCII_PUNCTUATION: Self

The set of all ASCII punctuation characters:

• U+0021 ..= U+002F ! " # $ % & ' ( ) * + , - . /
• U+003A ..= U+0040 : ; < = > ? @
• U+005B ..= U+0060 [ \ ] ^ _ `
• U+007B ..= U+007E { | } ~

Examples

This contains all bytes for which u8::is_ascii_punctuation returns true:

for byte in ByteSet::ASCII_PUNCTUATION {
    assert!(byte.is_ascii_punctuation());
}

for byte in !ByteSet::ASCII_PUNCTUATION {
    assert!(!byte.is_ascii_punctuation());
}

pub const ASCII_GRAPHIC: Self

The set of all ASCII graphic characters: U+0021 '!' ..= U+007E '~'.

Examples

This contains all bytes for which u8::is_ascii_graphic returns true:

for byte in ByteSet::ASCII_GRAPHIC {
    assert!(byte.is_ascii_graphic());
}

for byte in !ByteSet::ASCII_GRAPHIC {
    assert!(!byte.is_ascii_graphic());
}

pub const ASCII_WHITESPACE: Self

The set of all ASCII whitespace characters:

• U+0020 SPACE
• U+0009 HORIZONTAL TAB
• U+000A LINE FEED
• U+000C FORM FEED
• U+000D CARRIAGE RETURN

Examples

This contains all bytes for which u8::is_ascii_whitespace returns true:

for byte in ByteSet::ASCII_WHITESPACE {
    assert!(byte.is_ascii_whitespace());
}

for byte in !ByteSet::ASCII_WHITESPACE {
    assert!(!byte.is_ascii_whitespace());
}

pub const ASCII_CONTROL: Self

The set of all ASCII control characters:

• U+0000 NUL ..= U+001F UNIT SEPARATOR
• U+007F DELETE.

Note that most ASCII whitespace characters are control characters, but SPACE is not.

Examples

This contains all bytes for which u8::is_ascii_control returns true:

for byte in ByteSet::ASCII_CONTROL {
    assert!(byte.is_ascii_control());
}

for byte in !ByteSet::ASCII_CONTROL {
    assert!(!byte.is_ascii_control());
}

#[must_use]pub const fn is_empty(&self) -> bool

Returns true if self contains no bytes.

This is more efficient than checking self.len() == 0.

#[must_use]pub const fn is_full(&self) -> bool

Returns true if self contains all bytes.

This is more efficient than checking self.len() == 256.

#[must_use]pub const fn is_ascii(&self) -> bool

Returns true if self contains only ASCII characters, or is empty.

This is more efficient than checking whether self.last() is ASCII or None.

#[must_use]pub const fn len(&self) -> usize

Returns the number of bytes contained in self.

pub fn clear(&mut self)

Removes all bytes from self.

pub fn first(&self) -> Option<u8>

Returns the first (least) byte in self, or None if self is empty.

pub fn pop_first(&mut self) -> Option<u8>

Removes the first (least) byte in self and returns it, or None if self is empty.

pub fn last(&self) -> Option<u8>

Returns the last (greatest) byte in self, or None if self is empty.

pub fn pop_last(&mut self) -> Option<u8>

Removes the last (least) byte in self and returns it, or None if self is empty.

pub fn insert(&mut self, byte: u8)

Inserts byte into self in-place.

Unlike HashSet::insert and BTreeSet::insert, this does not return a bool for whether byte was not present. This is because it's just as efficient to call contains before.

pub fn insert_all(&mut self, other: Self)

Inserts all bytes of other into self in-place.

#[must_use]pub const fn inserting(self, byte: u8) -> Self

Returns a copy of self with byte inserted.

#[must_use]pub const fn inserting_all(self, other: Self) -> Self

Returns a copy of self with all of other inserted.

This is equivalent to the union method.

pub fn remove(&mut self, byte: u8)

Removes byte from self in-place.

Unlike HashSet::remove and BTreeSet::remove, this does not return a bool for whether byte was present. This is because it's just as efficient to call contains before.

pub fn remove_all(&mut self, other: Self)

Removes all bytes of other from self in-place.

#[must_use]pub const fn removing(self, byte: u8) -> Self

Returns a copy of self with byte removed.

#[must_use]pub const fn removing_all(self, other: Self) -> Self

Returns a copy of self with byte removed.

pub fn set(&mut self, byte: u8, enabled: bool)

Sets byte in self to enabled in-place.

#[must_use]pub const fn setting(self, byte: u8, enabled: bool) -> Self

Returns a copy of self with byte set to enabled.

#[must_use]pub const fn contains(&self, byte: u8) -> bool

Returns true if byte is contained in self.

#[must_use]pub fn contains_any(&self, other: &Self) -> bool

Returns true if self contains any bytes in other.

#[must_use]pub fn is_subset(&self, other: &Self) -> bool

Returns true if other contains all bytes in self.

#[must_use]pub fn is_strict_subset(&self, other: &Self) -> bool

Returns true if other contains all bytes in self and at least one other byte not contained in self.

This is also known as a "proper subset".

#[must_use]pub fn is_superset(&self, other: &Self) -> bool

Returns true if self contains all bytes in other.

#[must_use]pub fn is_strict_superset(&self, other: &Self) -> bool

Returns true if self contains all bytes in other and at least one other byte not contained in other.

This is also known as a "proper superset".

#[must_use]pub fn is_disjoint(&self, other: &Self) -> bool

Returns true if self and other have no bytes in common.

#[must_use]pub const fn difference(self, other: Self) -> Self

Returns a set with the bytes contained in self, but not in other.

#[must_use]pub const fn symmetric_difference(self, other: Self) -> Self

Returns a set with the bytes contained in self or other, but not in both.

#[must_use]pub const fn intersection(self, other: Self) -> Self

Returns a set with the bytes contained both in self and other.

#[must_use]pub const fn union(self, other: Self) -> Self

Returns a new set with the bytes contained in self or other.

#[must_use]pub const fn not(self) -> Self

Returns a new set with the bytes not contained in self.

This exists because the Not trait cannot be used in const yet.

#[must_use]pub const fn reverse_bits(self) -> Self

Returns self with its bits reversed.

This is equivalent to checking for 255 - b in all subsequent searches of b.

#[must_use]pub const fn eq(&self, other: &Self) -> bool

Returns true if self and other contain the same bytes.

This exists because PartialEq is currently unstable in const.

#[must_use]pub const fn ne(&self, other: &Self) -> bool

Returns true if self and other do not contain the same bytes.

This exists because PartialEq is currently unstable in const.

impl ByteSet

Operations over the internal memory representation.

pub fn as_bytes(&self) -> &[u8; 32]

Returns a shared reference to the underlying bytes of self.

pub fn as_bytes_mut(&mut self) -> &mut [u8; 32]

Returns a mutable reference to the underlying bytes of self.

pub fn slice_as_bytes(slice: &[Self]) -> &[u8]

Returns a shared reference to the underlying bytes of slice.

pub fn slice_as_bytes_mut(slice: &mut [Self]) -> &mut [u8]

Returns a mutable reference to the underlying bytes of slice.

Trait Implementations

impl BitAnd<ByteSet> for ByteSet

type Output = Self

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<ByteSet> for ByteSet

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<ByteSet> for ByteSet

type Output = Self

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<ByteSet> for ByteSet

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<ByteSet> for ByteSet

type Output = Self

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<ByteSet> for ByteSet

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for ByteSet

fn clone(&self) -> ByteSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ByteSet

impl Debug for ByteSet

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

Formats the value using the given formatter.

impl Default for ByteSet

fn default() -> Self

Returns the "default value" for a type.

impl Distribution<ByteSet> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> ByteSet

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
    R: Rng, 

Create an iterator that generates random values of T, using rng as the source of randomness.

impl Eq for ByteSet

impl<'a> Extend<&'a u8> for ByteSet

fn extend<T: IntoIterator<Item = &'a u8>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<u8> for ByteSet

fn extend<T: IntoIterator<Item = u8>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'_> From<&'_ [u8]> for ByteSet

fn from(bytes: &[u8]) -> Self

Performs the conversion.

impl<'_> From<&'_ str> for ByteSet

fn from(s: &str) -> Self

Performs the conversion.

impl From<ByteSet> for Iter

fn from(byte_set: ByteSet) -> Self

Performs the conversion.

impl From<u8> for ByteSet

fn from(byte: u8) -> ByteSet

Performs the conversion.

impl<'a> FromIterator<&'a u8> for ByteSet

fn from_iter<T: IntoIterator<Item = &'a u8>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<u8> for ByteSet

fn from_iter<T: IntoIterator<Item = u8>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for ByteSet

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl IntoIterator for ByteSet

type Item = u8

The type of the elements being iterated over.

type IntoIter = Iter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Not for ByteSet

type Output = Self

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for ByteSet

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ByteSet> for ByteSet

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

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

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

This method tests for !=.

impl PartialOrd<ByteSet> for ByteSet

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ByteSet

impl StructuralPartialEq for ByteSet

impl Sub<ByteSet> for ByteSet

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<ByteSet> for ByteSet

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.