Struct Brightness

pub struct Brightness(/* private fields */);

A strongly-typed wrapper around brightness values (0–127), used for setting LED brightness.

Implementations

impl Brightness

pub const MIN: u8 = 0u8

pub const MAX: u8 = 127u8

pub fn new(value: u8) -> Option<Self>

Tries to create a new Brightness, returning None if out of range.

pub fn min() -> Self

Returns the minimum brightness (off).

pub fn max() -> Self

Returns the maximum brightness (full brightness).

pub fn value(self) -> u8

Returns the inner u8 value.

Trait Implementations

impl Clone for Brightness

fn clone(&self) -> Brightness

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Brightness

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

Formats the value using the given formatter.

impl Ord for Brightness

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

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

fn partial_cmp(&self, other: &Brightness) -> 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 TryFrom<u8> for Brightness

fn try_from(value: u8) -> Result<Self, Self::Error>

Brightness must be in the range 0–127 (0x00–0x7F in HEX).

type Error = &'static str

The type returned in the event of a conversion error.

impl Copy for Brightness

impl Eq for Brightness

impl StructuralPartialEq for Brightness