Struct ModifierCombination 

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

The bit representation of the modifier combination.

Implementations

impl ModifierCombination

pub const fn new() -> Self

Creates a new default initialized bitfield.

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

Convert from bits.

pub const fn into_bits(self) -> u8

Convert into bits.

pub const fn left_ctrl(&self) -> bool

Bits: 0..1

pub const fn with_left_ctrl_checked(self, value: bool) -> Result<Self, ()>

Bits: 0..1

pub const fn with_left_ctrl(self, value: bool) -> Self

Bits: 0..1

pub const fn set_left_ctrl(&mut self, value: bool)

Bits: 0..1

pub const fn set_left_ctrl_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 0..1

pub const fn left_shift(&self) -> bool

Bits: 1..2

pub const fn with_left_shift_checked(self, value: bool) -> Result<Self, ()>

Bits: 1..2

pub const fn with_left_shift(self, value: bool) -> Self

Bits: 1..2

pub const fn set_left_shift(&mut self, value: bool)

Bits: 1..2

pub const fn set_left_shift_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 1..2

pub const fn left_alt(&self) -> bool

Bits: 2..3

pub const fn with_left_alt_checked(self, value: bool) -> Result<Self, ()>

Bits: 2..3

pub const fn with_left_alt(self, value: bool) -> Self

Bits: 2..3

pub const fn set_left_alt(&mut self, value: bool)

Bits: 2..3

pub const fn set_left_alt_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 2..3

pub const fn left_gui(&self) -> bool

Bits: 3..4

pub const fn with_left_gui_checked(self, value: bool) -> Result<Self, ()>

Bits: 3..4

pub const fn with_left_gui(self, value: bool) -> Self

Bits: 3..4

pub const fn set_left_gui(&mut self, value: bool)

Bits: 3..4

pub const fn set_left_gui_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 3..4

pub const fn right_ctrl(&self) -> bool

Bits: 4..5

pub const fn with_right_ctrl_checked(self, value: bool) -> Result<Self, ()>

Bits: 4..5

pub const fn with_right_ctrl(self, value: bool) -> Self

Bits: 4..5

pub const fn set_right_ctrl(&mut self, value: bool)

Bits: 4..5

pub const fn set_right_ctrl_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 4..5

pub const fn right_shift(&self) -> bool

Bits: 5..6

pub const fn with_right_shift_checked(self, value: bool) -> Result<Self, ()>

Bits: 5..6

pub const fn with_right_shift(self, value: bool) -> Self

Bits: 5..6

pub const fn set_right_shift(&mut self, value: bool)

Bits: 5..6

pub const fn set_right_shift_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 5..6

pub const fn right_alt(&self) -> bool

Bits: 6..7

pub const fn with_right_alt_checked(self, value: bool) -> Result<Self, ()>

Bits: 6..7

pub const fn with_right_alt(self, value: bool) -> Self

Bits: 6..7

pub const fn set_right_alt(&mut self, value: bool)

Bits: 6..7

pub const fn set_right_alt_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 6..7

pub const fn right_gui(&self) -> bool

Bits: 7..8

pub const fn with_right_gui_checked(self, value: bool) -> Result<Self, ()>

Bits: 7..8

pub const fn with_right_gui(self, value: bool) -> Self

Bits: 7..8

pub const fn set_right_gui(&mut self, value: bool)

Bits: 7..8

pub const fn set_right_gui_checked(&mut self, value: bool) -> Result<(), ()>

Bits: 7..8

impl ModifierCombination

pub const LCTRL: Self

pub const LSHIFT: Self

pub const LALT: Self

pub const LGUI: Self

pub const RCTRL: Self

pub const RSHIFT: Self

pub const RALT: Self

pub const RGUI: Self

pub const fn new_from( right: bool, gui: bool, alt: bool, shift: bool, ctrl: bool, ) -> Self

pub const fn new_from_vals( left_ctrl: bool, left_shift: bool, left_alt: bool, left_gui: bool, right_ctrl: bool, right_shift: bool, right_alt: bool, right_gui: bool, ) -> Self

pub const fn into_packed_bits(self) -> u8

Convert current modifier into packed bits:

bit4	bit3	bit2	bit1	bit0
L/R	GUI	ALT	SHIFT	CTRL

WARN: Since the packed version cannot represent the state that BOTH left and right modifier is present, the left side has higher priority

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

Convert packed bits back into ModifierCombination:

bit4	bit3	bit2	bit1	bit0
L/R	GUI	ALT	SHIFT	CTRL

If bit4 is 0, modifiers are applied to left side, otherwise right side

Trait Implementations

impl BitAnd for ModifierCombination

type Output = ModifierCombination

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for ModifierCombination

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for ModifierCombination

type Output = ModifierCombination

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for ModifierCombination

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl Clone for ModifierCombination

fn clone(&self) -> ModifierCombination

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModifierCombination

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

Formats the value using the given formatter.

impl Default for ModifierCombination

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModifierCombination

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ModifierCombination> for u8

fn from(v: ModifierCombination) -> u8

Converts to this type from the input type.

impl From<u8> for ModifierCombination

fn from(v: u8) -> Self

Converts to this type from the input type.

impl MaxSize for ModifierCombination

const POSTCARD_MAX_SIZE: usize = 1usize

The maximum possible size that the serialization of this type can have, in bytes.

impl Not for ModifierCombination

type Output = ModifierCombination

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for ModifierCombination

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ModifierCombination

impl Eq for ModifierCombination

impl StructuralPartialEq for ModifierCombination