Struct Modifiers 

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

The modifier bits carried by an event (FWL_EVENTFLAG).

A hand-written bitflag newtype: nine constants and a handful of operations, sharing the algebra of pdfrum_font::FontFlags and pdfrum_doc::AnnotFlags, unknown-bit retention included.

use pdfrum_form::Modifiers;

let m = Modifiers::SHIFT | Modifiers::CONTROL;
assert!(m.contains(Modifiers::SHIFT));
assert!(!m.without(Modifiers::SHIFT).contains(Modifiers::SHIFT));
assert_eq!(Modifiers::from_bits(1 << 30).bits(), 1 << 30);

Implementations

impl Modifiers

pub const NONE: Self

No modifiers held.

pub const SHIFT: Self

Shift.

pub const CONTROL: Self

Control.

pub const ALT: Self

Alt.

pub const META: Self

Meta — Command on Apple keyboards.

pub const KEYPAD: Self

The key came from the numeric keypad.

pub const AUTO_REPEAT: Self

The key is repeating because it is held down.

pub const LEFT_BUTTON: Self

The left mouse button is down.

pub const MIDDLE_BUTTON: Self

The middle mouse button is down.

pub const RIGHT_BUTTON: Self

The right mouse button is down.

pub const fn bits(self) -> u32

The raw modifier word, including any bit this type does not name.

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

The word as a host reported it. Unknown bits are retained.

pub const fn contains(self, other: Self) -> bool

Whether every bit of other is set here.

Modifiers::NONE is contained in everything, which is what makes contains the wrong question to ask about “no modifiers held” — use == Modifiers::NONE for that.

pub const fn union(self, other: Self) -> Self

Both sets of bits.

pub const fn with(self, other: Self) -> Self

A copy with other’s bits set. An alias for Modifiers::union.

pub const fn without(self, other: Self) -> Self

The bits of self that are not in other.

pub const fn is_empty(self) -> bool

Whether no bit at all is set.

Trait Implementations

impl BitOr for Modifiers

type Output = Modifiers

The resulting type after applying the | operator.

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

Performs the | operation.

impl Clone for Modifiers

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Modifiers

impl Debug for Modifiers

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

Formats the value using the given formatter.

impl Default for Modifiers

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Modifiers

impl Hash for Modifiers

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Modifiers

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Modifiers