Struct Byteset 

pub struct Byteset<const N: usize>(/* private fields */);

Bitset of variable size. N is size in bytes of the Byteset.

Implementations

impl<const N: usize> Byteset<N>

pub const fn new(inner: [u8; N]) -> Byteset<N>

Constructs a new value of Byteset.

Examples

use bitworks::prelude::{Bitset, Byteset};

let bitset = Byteset::<1>::new([19]);

assert_eq!(bitset, Byteset::<1>::from_repr([19]));

pub const fn into_inner(&self) -> [u8; N]

Returns the inner [u8; N] representation of Byteset.

Examples

use bitworks::prelude::Byteset;

let bitset = Byteset::<1>::new([19]);
let inner: [u8; 1] = bitset.into_inner();

assert_eq!(inner, [19]);

Trait Implementations

impl<const N: usize> Binary for Byteset<N>

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

Formats the value using the given formatter.

impl<const N: usize> BitAnd for Byteset<N>

type Output = Byteset<N>

The resulting type after applying the & operator.

fn bitand(self, rhs: Byteset<N>) -> <Byteset<N> as BitAnd>::Output

Performs the & operation.

impl<const N: usize> BitAnd<Index<Byteset<N>>> for Byteset<N>

type Output = Byteset<N>

The resulting type after applying the & operator.

fn bitand( self, rhs: Index<Byteset<N>>, ) -> <Byteset<N> as BitAnd<Index<Byteset<N>>>>::Output

Performs the & operation.

impl<const N: usize> BitAndAssign for Byteset<N>

fn bitand_assign(&mut self, rhs: Byteset<N>)

Performs the &= operation.

impl<const N: usize> BitAndAssign<Index<Byteset<N>>> for Byteset<N>

fn bitand_assign(&mut self, rhs: Index<Byteset<N>>)

Performs the &= operation.

impl<const N: usize> BitOr for Byteset<N>

type Output = Byteset<N>

The resulting type after applying the | operator.

fn bitor(self, rhs: Byteset<N>) -> <Byteset<N> as BitOr>::Output

Performs the | operation.

impl<const N: usize> BitOr<Index<Byteset<N>>> for Byteset<N>

type Output = Byteset<N>

The resulting type after applying the | operator.

fn bitor( self, rhs: Index<Byteset<N>>, ) -> <Byteset<N> as BitOr<Index<Byteset<N>>>>::Output

Performs the | operation.

impl<const N: usize> BitOrAssign for Byteset<N>

fn bitor_assign(&mut self, rhs: Byteset<N>)

Performs the |= operation.

impl<const N: usize> BitOrAssign<Index<Byteset<N>>> for Byteset<N>

fn bitor_assign(&mut self, rhs: Index<Byteset<N>>)

Performs the |= operation.

impl<const N: usize> BitXor for Byteset<N>

type Output = Byteset<N>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Byteset<N>) -> <Byteset<N> as BitXor>::Output

Performs the ^ operation.

impl<const N: usize> BitXor<Index<Byteset<N>>> for Byteset<N>

type Output = Byteset<N>

The resulting type after applying the ^ operator.

fn bitxor( self, rhs: Index<Byteset<N>>, ) -> <Byteset<N> as BitXor<Index<Byteset<N>>>>::Output

Performs the ^ operation.

impl<const N: usize> BitXorAssign for Byteset<N>

fn bitxor_assign(&mut self, rhs: Byteset<N>)

Performs the ^= operation.

impl<const N: usize> BitXorAssign<Index<Byteset<N>>> for Byteset<N>

fn bitxor_assign(&mut self, rhs: Index<Byteset<N>>)

Performs the ^= operation.

impl<const N: usize> Clone for Byteset<N>

fn clone(&self) -> Byteset<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Byteset<N>

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

Formats the value using the given formatter.

impl<const N: usize> Display for Byteset<N>

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

Formats the value using the given formatter.

impl<const N: usize> Eq for Byteset<N>

impl From<Byteset<1>> for Bitset8

fn from(value: Byteset<1>) -> Bitset8

Converts to this type from the input type.

impl From<Byteset<2>> for Bitset16

fn from(value: Byteset<2>) -> Bitset16

Converts to this type from the input type.

impl From<Byteset<4>> for Bitset32

fn from(value: Byteset<4>) -> Bitset32

Converts to this type from the input type.

impl From<Byteset<8>> for Bitset64

fn from(value: Byteset<8>) -> Bitset64

Converts to this type from the input type.

impl From<Byteset<16>> for Bitset128

fn from(value: Byteset<16>) -> Bitset128

Converts to this type from the input type.

impl<const N: usize> From<Index<Byteset<N>>> for Byteset<N>

fn from(index: Index<Byteset<N>>) -> Byteset<N>

Converts to this type from the input type.

impl<const N: usize> From<[u8; N]> for Byteset<N>

fn from(value: [u8; N]) -> Byteset<N>

Converts to this type from the input type.

impl<const N: usize> FromIterator<Bit> for Byteset<N>

fn from_iter<T>(iter: T) -> Byteset<N>

where T: IntoIterator<Item = Bit>,

Creates a value from an iterator.

impl<const N: usize> Hash for Byteset<N>

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

where __H: Hasher,

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<const N: usize> LeftAligned for Byteset<N>

fn shift_left(self, amount: Index<Self>) -> Self

Shifts bit representation of the Bitset left by amount. Has signature and use identical to core::ops::Shl<Index<Self>>.

fn shift_right(self, amount: Index<Self>) -> Self

Shifts bit representation of the Bitset right by amount. Has signature and use identical to core::ops::Shr<Index<Self>>.

impl<const N: usize> LowerHex for Byteset<N>

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

Formats the value using the given formatter.

impl<const N: usize> Not for Byteset<N>

type Output = Byteset<N>

The resulting type after applying the ! operator.

fn not(self) -> <Byteset<N> as Not>::Output

Performs the unary ! operation.

impl<const N: usize> Octal for Byteset<N>

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

Formats the value using the given formatter.

impl<const N: usize> Ord for Byteset<N>

fn cmp(&self, other: &Byteset<N>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const N: usize> PartialEq for Byteset<N>

fn eq(&self, other: &Byteset<N>) -> 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<const N: usize> PartialOrd for Byteset<N>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<const N: usize> Shl<Index<Byteset<N>>> for Byteset<N>

type Output = Byteset<N>

The resulting type after applying the << operator.

fn shl( self, rhs: Index<Byteset<N>>, ) -> <Byteset<N> as Shl<Index<Byteset<N>>>>::Output

Performs the << operation.

impl<const N: usize> ShlAssign<Index<Byteset<N>>> for Byteset<N>

fn shl_assign(&mut self, rhs: Index<Byteset<N>>)

Performs the <<= operation.

impl<const N: usize> Shr<Index<Byteset<N>>> for Byteset<N>

type Output = Byteset<N>

The resulting type after applying the >> operator.

fn shr( self, rhs: Index<Byteset<N>>, ) -> <Byteset<N> as Shr<Index<Byteset<N>>>>::Output

Performs the >> operation.

impl<const N: usize> ShrAssign<Index<Byteset<N>>> for Byteset<N>

fn shr_assign(&mut self, rhs: Index<Byteset<N>>)

Performs the >>= operation.

impl<const N: usize> StructuralPartialEq for Byteset<N>

impl<const N: usize> UpperHex for Byteset<N>

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

Formats the value using the given formatter.