Struct Lights 

pub struct Lights { /* private fields */ }

A selection of button lights on the tablet. There are 10 buttons with 4 lights each for a total of 40 lights.

Ordering

The order is in Button order from Button::B0 to Button::B9 where each button has 4 lights together in the following order:

• “Top”
• “Left”
• “Right”
• “Bottom”

Implementations

impl Lights

pub const COUNT: usize

The number of lights on Boppo. Each button has four lights.

NOTE: that this is not the number of lights in this selection which is obtained by calling self.len()

pub fn from_slice(arr: &[bool]) -> Lights

Returns a selection containing all indices marked true in arr.

Panics

This function will panic if arr.len() > Lights::COUNT

pub const fn from_index(light_index: usize) -> Lights

Returns a Lights with only the light at light_index selected.

pub fn from_indices<I>(indexes: I) -> Lights

where I: IntoIterator<Item = usize>,

Returns a new Lights constructed from light indices contained in indexes.

Panics

This function will panic if indexes contains an index >= Lights::COUNT.

pub const fn from_bitset(bits: u64) -> Lights

Returns a new Lights with bits.

Each bit in bits represents whether an individual light has been selected. The least significant bit selects Button::B0.light_at(LightDir::Top).

Ordering

See Lights ordering.

Panics

This function will panic if bits >> Lights::COUNT != 0.

pub const fn all_from_button(button: Button) -> Lights

All 4 lights of button

pub const fn all() -> Lights

Returns a Lights with every light selected

pub const fn none() -> Lights

Returns a Lights with no light selected

pub const fn len(&self) -> u32

Returns the number of lights in this selection.

pub const fn is_empty(&self) -> bool

Returns true if no lights are selected.

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

Returns true if other selects only lights that self selects.

See also Lights::is_subset

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

Returns true if self selects only lights that other selects.

See also Lights::is_superset

pub const fn indices(&self) -> impl DoubleEndedIterator<Item = usize> + use<>

Returns a double-ended iterator over the indices of every light in this selection.

pub const fn invert(&self) -> Lights

Returns the inversion of the current selection.

pub fn choose_n_randomly(&self, n: usize) -> Lights

Randomly choose n of the lights that are active in self.

pub const fn rotate_180(&self) -> Lights

Return the Lights as if the device was rotated 180 degrees. Light 0 becomes 39, 1 becomes 38…

pub const fn as_bitset(&self) -> u64

A compact representation. The least significant bit represents if light 0 is selected…

pub fn set_color(self, color: RGB)

Sets all lights in this selection to color

pub fn set_colors(self, colors: &[RGB])

Sets each light in this selection to the corresponding color in colors, up to exhaustion of either the selection or colors.

pub const fn only(self, dir: LightDir) -> Lights

Returns a new Lights with only the lights in the dir direction from this selection.

Trait Implementations

impl BitAnd for Lights

type Output = Lights

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for Lights

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for Lights

type Output = Lights

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for Lights

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for Lights

type Output = Lights

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for Lights

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for Lights

fn clone(&self) -> Lights

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Lights

impl Debug for Lights

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

Formats the value using the given formatter.

impl Eq for Lights

impl From<Button> for Lights

fn from(button: Button) -> Self

Converts to this type from the input type.

impl From<Buttons> for Lights

fn from(buttons: Buttons) -> Self

Converts to this type from the input type.

impl IntoIterator for Lights

fn into_iter(self) -> Self::IntoIter

Iterates in order of index.

type Item = (Button, LightDir)

The type of the elements being iterated over.

type IntoIter = LightsIter

Which kind of iterator are we turning this into?

impl Not for Lights

type Output = Lights

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Lights

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

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

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