Struct ht16k33::LedLocation

pub struct LedLocation {
    pub row: DisplayDataAddress,
    pub common: DisplayData,
}

Represents the LED location.

The LED location is a (DisplayDataAddress, DisplayData) pair, created from a validated (row, common) pair of u8 values.

Example

use ht16k33::LedLocation;
use ht16k33::DisplayData;
use ht16k33::DisplayDataAddress;
use ht16k33::ValidationError;

let row = 1u8;
let common = 2u8;

let location = LedLocation::new(row, common)?;

assert_eq!(ht16k33::DisplayDataAddress::ROW_1, location.row);
assert_eq!(ht16k33::DisplayData::COMMON_2, location.common);

Fields

row: DisplayDataAddress

The Display RAM row address.

common: DisplayData

The Display RAM common data.

Methods

impl LedLocation

pub fn new(row: u8, common: u8) -> Result<Self, ValidationError>

Create an LedLocation with the given row and common values.

Errors

The row and common values are validated to be within their respective ROWS_SIZE and COMMONS_SIZE ranges of the device. If validation fails then ht16k33::ValidationError::ValueTooLarge is returned.

use ht16k33::LedLocation;
use ht16k33::ValidationError;

let location = match LedLocation::new(row, common) {
    Ok(location) => location,
    Err(ValidationError) => panic!(),
};

pub fn row_as_index(self) -> usize

Return the row value.

Trait Implementations

impl Eq for LedLocation

impl Ord for LedLocation

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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<LedLocation> for LedLocation

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

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

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

This method tests for !=.

impl Copy for LedLocation

impl Clone for LedLocation

fn clone(&self) -> LedLocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<LedLocation> for LedLocation

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

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

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

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

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

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

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

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

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

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

impl Default for LedLocation

fn default() -> LedLocation

Returns the "default value" for a type.

impl Debug for LedLocation

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

Formats the value using the given formatter.

impl Display for LedLocation

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

Formats the value using the given formatter.

impl Hash for LedLocation

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, 

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