Struct DrumFrame8

pub struct DrumFrame8 { /* private fields */ }

Available on crate feature audio only.

A set of 8 drum instruments.

Implementations

impl DrumFrame8

pub const CY: Self

Cymbal.

Ride or crash cymbal, depending on context.

Adds texture and color, often marking transitions or downbeats.

pub const CH: Self

Closed Hi-Hat.

A hi-hat played with the cymbals closed. Produces a short, crisp “chick” sound.

Drives the rhythm with a tight, precise feel.

pub const OH: Self

Open Hi-Hat.

A hi-hat played with the cymbals slightly apart. Produces a longer, sustaining sound.

Adds variation and accentuates beats or fills.

pub const BD: Self

Bass Drum.

The largest drum, played with a foot pedal, producing a deep, resonant sound.

Anchors the rhythm, often providing the downbeat in patterns.

pub const SD: Self

Snare Drum.

A drum with snares (metal wires) underneath, producing a sharp, cracking sound.

Central to most drum patterns, providing backbeat on the 2nd and 4th beats in 4/4 time.

pub const LT: Self

Low Tom.

The largest and lowest-pitched tom in a drum set (sometimes called the floor tom).

Adds weight and depth, commonly used in fills and breakdowns.

pub const CPS: Self

Claps.

A synthesized or sampled handclap sound.

Provides a human touch to electronic grooves or reinforces the snare in patterns.

pub const CB: Self

Cowbell.

A metallic percussion instrument producing a distinct, ringing tone.

Adds syncopation or an off-beat feel, famously used in Latin and funk rhythms.

pub const CYMBALS: Self

Cymbals.

pub const DRUMS: Self

Drums.

pub const TOMS: Self

Toms.

pub const AUXILIARY: Self

Auxiliary percussion.

impl DrumFrame8

Custom fields operations

pub const fn without_fields() -> Self

Returns a new DrumFrame8 with none of the fields set.

pub const fn with_all_fields() -> Self

Returns a new DrumFrame8 with all the fields set.

pub const fn are_all_fields(self) -> bool

Returns true if it all the fields are set.

impl DrumFrame8

CY single field operations

pub const fn with_field_cy() -> Self

Returns a new DrumFrame8 with CY field set.

pub const fn is_field_cy(self) -> bool

Whether the CY field is set.

pub const fn bits_field_cy(self) -> u32

The size in bits of the CY field.

pub const fn get_field_cy(self) -> Self

A copy of self with only the bits of CY field.

pub const fn set_field_cy(self) -> Self

A copy of self with the CY field set.

pub fn mut_set_field_cy(&mut self)

Sets the CY field.

pub const fn get_field_value_cy(self) -> Self

The value at the bit range of CY field.

pub const fn set_field_value_cy(self, value: u8) -> Self

Sets the value into the bitrange of CY field.

pub const fn unset_field_cy(self) -> Self

A copy of self with the CY field set.

pub fn mut_unset_field_cy(&mut self)

Unsets the CY field.

pub const fn flip_field_cy(self) -> Self

Returns a copy of self with the CY field flipped.

pub fn mut_flip_field_cy(&mut self)

Flips the CY field.

impl DrumFrame8

CH single field operations

pub const fn with_field_ch() -> Self

Returns a new DrumFrame8 with CH field set.

pub const fn is_field_ch(self) -> bool

Whether the CH field is set.

pub const fn bits_field_ch(self) -> u32

The size in bits of the CH field.

pub const fn get_field_ch(self) -> Self

A copy of self with only the bits of CH field.

pub const fn set_field_ch(self) -> Self

A copy of self with the CH field set.

pub fn mut_set_field_ch(&mut self)

Sets the CH field.

pub const fn get_field_value_ch(self) -> Self

The value at the bit range of CH field.

pub const fn set_field_value_ch(self, value: u8) -> Self

Sets the value into the bitrange of CH field.

pub const fn unset_field_ch(self) -> Self

A copy of self with the CH field set.

pub fn mut_unset_field_ch(&mut self)

Unsets the CH field.

pub const fn flip_field_ch(self) -> Self

Returns a copy of self with the CH field flipped.

pub fn mut_flip_field_ch(&mut self)

Flips the CH field.

impl DrumFrame8

OH single field operations

pub const fn with_field_oh() -> Self

Returns a new DrumFrame8 with OH field set.

pub const fn is_field_oh(self) -> bool

Whether the OH field is set.

pub const fn bits_field_oh(self) -> u32

The size in bits of the OH field.

pub const fn get_field_oh(self) -> Self

A copy of self with only the bits of OH field.

pub const fn set_field_oh(self) -> Self

A copy of self with the OH field set.

pub fn mut_set_field_oh(&mut self)

Sets the OH field.

pub const fn get_field_value_oh(self) -> Self

The value at the bit range of OH field.

pub const fn set_field_value_oh(self, value: u8) -> Self

Sets the value into the bitrange of OH field.

pub const fn unset_field_oh(self) -> Self

A copy of self with the OH field set.

pub fn mut_unset_field_oh(&mut self)

Unsets the OH field.

pub const fn flip_field_oh(self) -> Self

Returns a copy of self with the OH field flipped.

pub fn mut_flip_field_oh(&mut self)

Flips the OH field.

impl DrumFrame8

BD single field operations

pub const fn with_field_bd() -> Self

Returns a new DrumFrame8 with BD field set.

pub const fn is_field_bd(self) -> bool

Whether the BD field is set.

pub const fn bits_field_bd(self) -> u32

The size in bits of the BD field.

pub const fn get_field_bd(self) -> Self

A copy of self with only the bits of BD field.

pub const fn set_field_bd(self) -> Self

A copy of self with the BD field set.

pub fn mut_set_field_bd(&mut self)

Sets the BD field.

pub const fn get_field_value_bd(self) -> Self

The value at the bit range of BD field.

pub const fn set_field_value_bd(self, value: u8) -> Self

Sets the value into the bitrange of BD field.

pub const fn unset_field_bd(self) -> Self

A copy of self with the BD field set.

pub fn mut_unset_field_bd(&mut self)

Unsets the BD field.

pub const fn flip_field_bd(self) -> Self

Returns a copy of self with the BD field flipped.

pub fn mut_flip_field_bd(&mut self)

Flips the BD field.

impl DrumFrame8

SD single field operations

pub const fn with_field_sd() -> Self

Returns a new DrumFrame8 with SD field set.

pub const fn is_field_sd(self) -> bool

Whether the SD field is set.

pub const fn bits_field_sd(self) -> u32

The size in bits of the SD field.

pub const fn get_field_sd(self) -> Self

A copy of self with only the bits of SD field.

pub const fn set_field_sd(self) -> Self

A copy of self with the SD field set.

pub fn mut_set_field_sd(&mut self)

Sets the SD field.

pub const fn get_field_value_sd(self) -> Self

The value at the bit range of SD field.

pub const fn set_field_value_sd(self, value: u8) -> Self

Sets the value into the bitrange of SD field.

pub const fn unset_field_sd(self) -> Self

A copy of self with the SD field set.

pub fn mut_unset_field_sd(&mut self)

Unsets the SD field.

pub const fn flip_field_sd(self) -> Self

Returns a copy of self with the SD field flipped.

pub fn mut_flip_field_sd(&mut self)

Flips the SD field.

impl DrumFrame8

LT single field operations

pub const fn with_field_lt() -> Self

Returns a new DrumFrame8 with LT field set.

pub const fn is_field_lt(self) -> bool

Whether the LT field is set.

pub const fn bits_field_lt(self) -> u32

The size in bits of the LT field.

pub const fn get_field_lt(self) -> Self

A copy of self with only the bits of LT field.

pub const fn set_field_lt(self) -> Self

A copy of self with the LT field set.

pub fn mut_set_field_lt(&mut self)

Sets the LT field.

pub const fn get_field_value_lt(self) -> Self

The value at the bit range of LT field.

pub const fn set_field_value_lt(self, value: u8) -> Self

Sets the value into the bitrange of LT field.

pub const fn unset_field_lt(self) -> Self

A copy of self with the LT field set.

pub fn mut_unset_field_lt(&mut self)

Unsets the LT field.

pub const fn flip_field_lt(self) -> Self

Returns a copy of self with the LT field flipped.

pub fn mut_flip_field_lt(&mut self)

Flips the LT field.

impl DrumFrame8

CPS single field operations

pub const fn with_field_cps() -> Self

Returns a new DrumFrame8 with CPS field set.

pub const fn is_field_cps(self) -> bool

Whether the CPS field is set.

pub const fn bits_field_cps(self) -> u32

The size in bits of the CPS field.

pub const fn get_field_cps(self) -> Self

A copy of self with only the bits of CPS field.

pub const fn set_field_cps(self) -> Self

A copy of self with the CPS field set.

pub fn mut_set_field_cps(&mut self)

Sets the CPS field.

pub const fn get_field_value_cps(self) -> Self

The value at the bit range of CPS field.

pub const fn set_field_value_cps(self, value: u8) -> Self

Sets the value into the bitrange of CPS field.

pub const fn unset_field_cps(self) -> Self

A copy of self with the CPS field set.

pub fn mut_unset_field_cps(&mut self)

Unsets the CPS field.

pub const fn flip_field_cps(self) -> Self

Returns a copy of self with the CPS field flipped.

pub fn mut_flip_field_cps(&mut self)

Flips the CPS field.

impl DrumFrame8

CB single field operations

pub const fn with_field_cb() -> Self

Returns a new DrumFrame8 with CB field set.

pub const fn is_field_cb(self) -> bool

Whether the CB field is set.

pub const fn bits_field_cb(self) -> u32

The size in bits of the CB field.

pub const fn get_field_cb(self) -> Self

A copy of self with only the bits of CB field.

pub const fn set_field_cb(self) -> Self

A copy of self with the CB field set.

pub fn mut_set_field_cb(&mut self)

Sets the CB field.

pub const fn get_field_value_cb(self) -> Self

The value at the bit range of CB field.

pub const fn set_field_value_cb(self, value: u8) -> Self

Sets the value into the bitrange of CB field.

pub const fn unset_field_cb(self) -> Self

A copy of self with the CB field set.

pub fn mut_unset_field_cb(&mut self)

Unsets the CB field.

pub const fn flip_field_cb(self) -> Self

Returns a copy of self with the CB field flipped.

pub fn mut_flip_field_cb(&mut self)

Flips the CB field.

impl DrumFrame8

CYMBALS single field operations

pub const fn with_field_cymbals() -> Self

Returns a new DrumFrame8 with CYMBALS field set.

pub const fn is_field_cymbals(self) -> bool

Whether the CYMBALS field is set.

pub const fn bits_field_cymbals(self) -> u32

The size in bits of the CYMBALS field.

pub const fn get_field_cymbals(self) -> Self

A copy of self with only the bits of CYMBALS field.

pub const fn set_field_cymbals(self) -> Self

A copy of self with the CYMBALS field set.

pub fn mut_set_field_cymbals(&mut self)

Sets the CYMBALS field.

pub const fn get_field_value_cymbals(self) -> Self

The value at the bit range of CYMBALS field.

pub const fn set_field_value_cymbals(self, value: u8) -> Self

Sets the value into the bitrange of CYMBALS field.

pub const fn unset_field_cymbals(self) -> Self

A copy of self with the CYMBALS field set.

pub fn mut_unset_field_cymbals(&mut self)

Unsets the CYMBALS field.

pub const fn flip_field_cymbals(self) -> Self

Returns a copy of self with the CYMBALS field flipped.

pub fn mut_flip_field_cymbals(&mut self)

Flips the CYMBALS field.

impl DrumFrame8

DRUMS single field operations

pub const fn with_field_drums() -> Self

Returns a new DrumFrame8 with DRUMS field set.

pub const fn is_field_drums(self) -> bool

Whether the DRUMS field is set.

pub const fn bits_field_drums(self) -> u32

The size in bits of the DRUMS field.

pub const fn get_field_drums(self) -> Self

A copy of self with only the bits of DRUMS field.

pub const fn set_field_drums(self) -> Self

A copy of self with the DRUMS field set.

pub fn mut_set_field_drums(&mut self)

Sets the DRUMS field.

pub const fn get_field_value_drums(self) -> Self

The value at the bit range of DRUMS field.

pub const fn set_field_value_drums(self, value: u8) -> Self

Sets the value into the bitrange of DRUMS field.

pub const fn unset_field_drums(self) -> Self

A copy of self with the DRUMS field set.

pub fn mut_unset_field_drums(&mut self)

Unsets the DRUMS field.

pub const fn flip_field_drums(self) -> Self

Returns a copy of self with the DRUMS field flipped.

pub fn mut_flip_field_drums(&mut self)

Flips the DRUMS field.

impl DrumFrame8

TOMS single field operations

pub const fn with_field_toms() -> Self

Returns a new DrumFrame8 with TOMS field set.

pub const fn is_field_toms(self) -> bool

Whether the TOMS field is set.

pub const fn bits_field_toms(self) -> u32

The size in bits of the TOMS field.

pub const fn get_field_toms(self) -> Self

A copy of self with only the bits of TOMS field.

pub const fn set_field_toms(self) -> Self

A copy of self with the TOMS field set.

pub fn mut_set_field_toms(&mut self)

Sets the TOMS field.

pub const fn get_field_value_toms(self) -> Self

The value at the bit range of TOMS field.

pub const fn set_field_value_toms(self, value: u8) -> Self

Sets the value into the bitrange of TOMS field.

pub const fn unset_field_toms(self) -> Self

A copy of self with the TOMS field set.

pub fn mut_unset_field_toms(&mut self)

Unsets the TOMS field.

pub const fn flip_field_toms(self) -> Self

Returns a copy of self with the TOMS field flipped.

pub fn mut_flip_field_toms(&mut self)

Flips the TOMS field.

impl DrumFrame8

AUXILIARY single field operations

pub const fn with_field_auxiliary() -> Self

Returns a new DrumFrame8 with AUXILIARY field set.

pub const fn is_field_auxiliary(self) -> bool

Whether the AUXILIARY field is set.

pub const fn bits_field_auxiliary(self) -> u32

The size in bits of the AUXILIARY field.

pub const fn get_field_auxiliary(self) -> Self

A copy of self with only the bits of AUXILIARY field.

pub const fn set_field_auxiliary(self) -> Self

A copy of self with the AUXILIARY field set.

pub fn mut_set_field_auxiliary(&mut self)

Sets the AUXILIARY field.

pub const fn get_field_value_auxiliary(self) -> Self

The value at the bit range of AUXILIARY field.

pub const fn set_field_value_auxiliary(self, value: u8) -> Self

Sets the value into the bitrange of AUXILIARY field.

pub const fn unset_field_auxiliary(self) -> Self

A copy of self with the AUXILIARY field set.

pub fn mut_unset_field_auxiliary(&mut self)

Unsets the AUXILIARY field.

pub const fn flip_field_auxiliary(self) -> Self

Returns a copy of self with the AUXILIARY field flipped.

pub fn mut_flip_field_auxiliary(&mut self)

Flips the AUXILIARY field.

impl DrumFrame8

General bits manipulation functionality

pub const MAX_BIT: u32 = 7u32

the maximum valid bit index.

pub const fn with_bits(bits: u8) -> Self

Returns self with the given inner bits.

pub const fn new_zeroed() -> Self

Returns self with all bits set to 0.

pub const fn new_oned() -> Self

Returns self with all bits set to 1.

pub const fn bits(self) -> u8

Returns the inner bits.

pub const fn count_ones(&self) -> u32

The number of bits set (number of ones).

pub const fn count_zeros(&self) -> u32

The number of bits unset (number of zeros).

pub const fn is_empty(self) -> bool

Wether all bits are set to 0.

pub const fn is_full(self) -> bool

Whether all bits are set to 1.

pub const fn is_bit_set(self, index: u32) -> bool

Whether the bit at index is set.

Panics

Panics in debug if index > MAX_BIT.

pub const fn is_checked_bit_set( self, index: u32, ) -> Result<bool, MismatchedBounds>

Whether the bit at index is set, checked version.

Errors

• If index > MAX_BIT Returns

pub const fn get_bit(self, index: u32) -> Self

Returns a copy of self with only the value of the bit at index.

Panics

Panics in debug if index > MAX_BIT.

pub const fn get_checked_bit(self, index: u32) -> Result<Self, MismatchedBounds>

Returns a copy of self with only the value of the bit at index, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub const fn get_shifted_bit(self, index: u32) -> Self

Returns a copy of self with only the value of the bit at index shifted.

Panics

Panics in debug if index > MAX_BIT.

pub const fn get_shifted_checked_bit( self, index: u32, ) -> Result<Self, MismatchedBounds>

Returns a copy of self with only the value of the bit at index shifted, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub fn set_bit(self, index: u32) -> Self

Returns a copy of self setting the bit at index.

Panics

Panics in debug if index > MAX_BIT.

pub const fn set_checked_bit(self, index: u32) -> Result<Self, MismatchedBounds>

Returns a copy of self setting the bit at index, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub fn mut_set_bit(&mut self, index: u32)

Sets the bit at index.

Panics

Panics in debug if index > MAX_BIT.

pub fn mut_set_checked_bit( &mut self, index: u32, ) -> Result<(), MismatchedBounds>

Sets the bit at index, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub fn unset_bit(self, index: u32) -> Self

Returns a copy of self setting the bit at index.

Panics

Panics in debug if index > MAX_BIT.

pub const fn unset_checked_bit( self, index: u32, ) -> Result<Self, MismatchedBounds>

Returns a copy of self unsetting the bit at index, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub fn mut_unset_bit(&mut self, index: u32)

Unsets the bit at index.

Panics

Panics in debug if index > MAX_BIT.

pub fn mut_unset_checked_bit( &mut self, index: u32, ) -> Result<(), MismatchedBounds>

Unsets the bit at index, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub const fn flip(self) -> Self

Returns a copy of self with all its bits flipped.

pub fn mut_flip(&mut self)

Flips all the bits of self.

pub fn flip_bit(self, index: u32) -> Self

Returns a copy of self flipping the bit at index.

Panics

Panics in debug if index > MAX_BIT.

pub const fn flip_checked_bit( self, index: u32, ) -> Result<Self, MismatchedBounds>

Returns a copy of self flipping the bit at index, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub fn mut_flip_bit(&mut self, index: u32)

Flips the bit at index, unchecked version.

Panics

Panics in debug if index > MAX_BIT.

pub fn mut_flip_checked_bit( &mut self, index: u32, ) -> Result<(), MismatchedBounds>

Flips the bit at index, checked.

impl DrumFrame8

Bit ranges

pub const fn mask_range(start: u32, end: u32) -> Self

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

pub const fn get_range(self, start: u32, end: u32) -> Self

Gets a copy of self with only the bits from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Gets a copy of self with only the bits from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Gets the value of the bits in from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Gets the value of the bits from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn set_range(self, start: u32, end: u32) -> Self

Get a copy of self with bits set to 1 from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Get a copy of self with bits set to 1 from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

pub fn mut_set_range(&mut self, start: u32, end: u32)

Sets the bits from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

pub fn mut_set_checked_range( &mut self, start: u32, end: u32, ) -> Result<(), MismatchedBounds>

Sets the bits from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

pub const fn set_value_range(self, value: u8, start: u32, end: u32) -> Self

Gets a copy of self with the given value set into the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: u8, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Gets a copy of self with the given value set into the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: u8, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Gets a copy of self with the given checked value set into the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub fn mut_set_value_range(&mut self, value: u8, start: u32, end: u32)

Sets the given value into the [start..=end] range. Sets the bits from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

pub fn mut_set_value_checked_range( &mut self, value: u8, start: u32, end: u32, ) -> Result<(), MismatchedBounds>

Sets the given value into the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT and MismatchedIndices if start > end.

pub fn mut_set_checked_value_checked_range( &mut self, value: u8, start: u32, end: u32, ) -> Result<(), MismatchedBounds>

Sets the given checked value into the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Returns a copy of self with unset bits to 0 from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Returns a copy of self with unset bits to 0 from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

pub fn mut_unset_range(&mut self, start: u32, end: u32)

Unsets the bits from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

pub fn mut_unset_checked_range( &mut self, start: u32, end: u32, ) -> Result<(), MismatchedBounds>

Unsets the bits from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Returns a copy of self with flipped bits from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Returns a copy of self with flipped bits from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

pub fn mut_flip_range(&mut self, start: u32, end: u32)

Flips the bits from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

pub fn mut_flip_checked_range( &mut self, start: u32, end: u32, ) -> Result<(), MismatchedBounds>

Flips the bits from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

impl DrumFrame8

Bit masks

pub const fn contains_mask(self, mask: u8) -> bool

Whether self contains all the same set bits that are set in mask.

pub const fn contains_other(self, other: Self) -> bool

Whether self contains all the same set bits that are set in other.

pub const fn overlaps_mask(&self, mask: u8) -> bool

Whether there’s at least one set bit in common between self and mask.

pub const fn overlaps_other(&self, other: Self) -> bool

Whether there’s at least one set bit in common between self and other.

pub const fn intersect_mask(self, mask: u8) -> Self

A copy of self with only the bits both in self and mask.

pub const fn intersect_other(self, other: Self) -> Self

A copy of self with only the bits both in self and other.

pub fn mut_intersect_mask(&mut self, mask: u8)

Only leaves the bits both in self and mask.

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

Only leaves the bits both in self and other.

pub const fn set_mask(self, mask: u8) -> Self

A copy of self setting the bits that are set in mask.

pub const fn set_other(self, other: Self) -> Self

A copy of self setting the bits that are set in other.

pub fn mut_set_mask(&mut self, mask: u8)

Sets the bits that are set in mask.

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

Sets the bits that are set in other.

pub const fn unset_mask(self, mask: u8) -> Self

A copy of self unsetting the bits that are set in mask.

pub const fn unset_other(self, other: Self) -> Self

A copy of self unsetting the bits that are set in other.

pub fn mut_unset_mask(&mut self, mask: u8)

Unsets the bits that are set in mask.

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

Unsets the bits that are set in other.

pub const fn flip_mask(self, mask: u8) -> Self

A copy of self flipping the bits that are set in mask.

pub const fn flip_other(self, other: Self) -> Self

Returns a copy of self flipping the bits that are set in other.

pub fn mut_flip_mask(&mut self, mask: u8)

Flips the bits that are set in mask.

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

Flips the bits that are set in other.

Trait Implementations

impl Binary for DrumFrame8

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

Formats the value using the given formatter.

impl Clone for DrumFrame8

fn clone(&self) -> DrumFrame8

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DrumFrame8

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

Formats the value using the given formatter.

impl Default for DrumFrame8

fn default() -> Self

Returns the “default value” for a type.

impl Display for DrumFrame8

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

Formats the value using the given formatter.

impl Hash for DrumFrame8

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 LowerExp for DrumFrame8

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

Formats the value using the given formatter.

impl LowerHex for DrumFrame8

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

Formats the value using the given formatter.

impl Octal for DrumFrame8

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

Formats the value using the given formatter.

impl Ord for DrumFrame8

fn cmp(&self, other: &DrumFrame8) -> 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 PartialEq for DrumFrame8

fn eq(&self, other: &DrumFrame8) -> 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 PartialOrd for DrumFrame8

fn partial_cmp(&self, other: &DrumFrame8) -> 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 UpperExp for DrumFrame8

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

Formats the value using the given formatter.

impl UpperHex for DrumFrame8

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

Formats the value using the given formatter.

impl Copy for DrumFrame8

impl Eq for DrumFrame8

impl StructuralPartialEq for DrumFrame8