Struct ps2::LEDState

pub struct LEDState { /* private fields */ }

Implementations

impl LEDState

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl LEDState

pub const fn into_bytes(self) -> [u8; 1]

Returns the underlying bits.

Layout

The returned byte array is layed out in the same way as described here.

pub const fn from_bytes(bytes: [u8; 1]) -> Self

Converts the given bytes directly into the bitfield struct.

impl LEDState

pub fn scroll_lock(&self) -> <bool as Specifier>::InOut

Returns the value of scroll_lock.

pub fn scroll_lock_or_err( &self ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of scroll_lock.

#Errors

If the returned value contains an invalid bit pattern for scroll_lock.

pub fn with_scroll_lock(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of scroll_lock set to the given value.

#Panics

If the given value is out of bounds for scroll_lock.

pub fn with_scroll_lock_checked( self, new_val: <bool as Specifier>::InOut ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of scroll_lock set to the given value.

#Errors

If the given value is out of bounds for scroll_lock.

pub fn set_scroll_lock(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of scroll_lock to the given value.

#Panics

If the given value is out of bounds for scroll_lock.

pub fn set_scroll_lock_checked( &mut self, new_val: <bool as Specifier>::InOut ) -> Result<(), OutOfBounds>

Sets the value of scroll_lock to the given value.

#Errors

If the given value is out of bounds for scroll_lock.

pub fn number_lock(&self) -> <bool as Specifier>::InOut

Returns the value of number_lock.

pub fn number_lock_or_err( &self ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of number_lock.

#Errors

If the returned value contains an invalid bit pattern for number_lock.

pub fn with_number_lock(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of number_lock set to the given value.

#Panics

If the given value is out of bounds for number_lock.

pub fn with_number_lock_checked( self, new_val: <bool as Specifier>::InOut ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of number_lock set to the given value.

#Errors

If the given value is out of bounds for number_lock.

pub fn set_number_lock(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of number_lock to the given value.

#Panics

If the given value is out of bounds for number_lock.

pub fn set_number_lock_checked( &mut self, new_val: <bool as Specifier>::InOut ) -> Result<(), OutOfBounds>

Sets the value of number_lock to the given value.

#Errors

If the given value is out of bounds for number_lock.

pub fn caps_lock(&self) -> <bool as Specifier>::InOut

Returns the value of caps_lock.

pub fn caps_lock_or_err( &self ) -> Result<<bool as Specifier>::InOut, InvalidBitPattern<<bool as Specifier>::Bytes>>

Returns the value of caps_lock.

#Errors

If the returned value contains an invalid bit pattern for caps_lock.

pub fn with_caps_lock(self, new_val: <bool as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of caps_lock set to the given value.

#Panics

If the given value is out of bounds for caps_lock.

pub fn with_caps_lock_checked( self, new_val: <bool as Specifier>::InOut ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of caps_lock set to the given value.

#Errors

If the given value is out of bounds for caps_lock.

pub fn set_caps_lock(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of caps_lock to the given value.

#Panics

If the given value is out of bounds for caps_lock.

pub fn set_caps_lock_checked( &mut self, new_val: <bool as Specifier>::InOut ) -> Result<(), OutOfBounds>

Sets the value of caps_lock to the given value.

#Errors

If the given value is out of bounds for caps_lock.

Trait Implementations

impl CheckFillsUnalignedBits for LEDState

type CheckType = [(); 1]

impl Clone for LEDState

fn clone(&self) -> LEDState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LEDState

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

Formats the value using the given formatter.