Struct Modifiers

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

A key’s logical modifiers.

This struct combines zero or more logical modifiers. In fact, it defaults to zero modifiers.

Implementations

impl Modifiers

pub fn from_escape(code: u16) -> Option<Self>

Decode an ANSI escape parameter.

pub const fn is_empty(&self) -> bool

Determine whether there are no active modifiers.

pub const fn len(&self) -> usize

Get the number of active modifiers.

pub fn has(&self, modifier: Modifier) -> bool

Determine whether the given modifier is enabled.

pub fn modifiers(&self) -> ModifierIter

Get an iterator over the active modifiers.

Trait Implementations

impl<M: Into<Modifiers>> Add<M> for Modifiers

type Output = Modifiers

The resulting type after applying the + operator.

fn add(self, rhs: M) -> Self::Output

Performs the + operation.

impl<M: Into<Modifiers>> AddAssign<M> for Modifiers

fn add_assign(&mut self, rhs: M)

Performs the += operation.

impl Clone for Modifiers

fn clone(&self) -> Modifiers

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Modifiers

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

Formats the value using the given formatter.

impl Default for Modifiers

fn default() -> Modifiers

Returns the “default value” for a type.

impl From<Modifier> for Modifiers

fn from(value: Modifier) -> Self

Converts to this type from the input type.

impl PartialEq for Modifiers

fn eq(&self, other: &Modifiers) -> 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<M: Into<Modifiers>> Sub<M> for Modifiers

type Output = Modifiers

The resulting type after applying the - operator.

fn sub(self, rhs: M) -> Self::Output

Performs the - operation.

impl<M: Into<Modifiers>> SubAssign<M> for Modifiers

fn sub_assign(&mut self, rhs: M)

Performs the -= operation.

impl Copy for Modifiers

impl Eq for Modifiers

impl StructuralPartialEq for Modifiers