Struct fidl_fuchsia_ui_input3::LockState

pub struct LockState { /* private fields */ }

A bit field of lock states which are currently active.

Lock state reports whether the lock is active for the keys which have a lock state (need to be pressed once to activate, and one more time to deactivate). A set bit denotes active lock state.

For example, when Caps Lock is active, i.e. pressing ‘a’ produces the effect of ‘A’ appearing on the screen, the CAPS_LOCK bit will be active.

The bit values in LockState are chosen to correspond to the values in Modifiers, to the extent that this is doable in the long run.

Implementations

impl LockState

pub const CAPS_LOCK: Self = _

Applies when the CAPS_LOCK modifier is locked.

Users should bear in mind that the effect of CAPS_LOCK is limited to alphabetic keys (not even alphanumerics) mainly.

For example, pressing a on a US QWERTY keyboard while CAPS_LOCK state is locked results in the key meaning A, just as if the Shift modifier was used. However, pressing [ when CAPS_LOCK is locked gives [, even though Shift+[ gives {.

The position of alphabetic keys may vary depending on the keymap in current use too.

pub const NUM_LOCK: Self = _

Applies when the NUM_LOCK modifier is locked.

pub const SCROLL_LOCK: Self = _

Applies when the SCROLL_LOCK modifier is locked.

pub const FUNCTION_LOCK: Self = _

Applies when the FUNCTION modifier is locked.

pub const SYMBOL_LOCK: Self = _

Applies when the SYMBOL modifier is locked.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u64) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u64) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u64) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

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

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

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

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

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

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

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

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

impl LockState

pub fn from_bits_allow_unknown(bits: u64) -> Self

pub fn has_unknown_bits(&self) -> bool

pub fn get_unknown_bits(&self) -> u64

Trait Implementations

impl Binary for LockState

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

Formats the value using the given formatter.

impl BitAnd for LockState

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

type Output = LockState

The resulting type after applying the & operator.

impl BitAndAssign for LockState

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for LockState

fn bitor(self, other: LockState) -> Self

Returns the union of the two sets of flags.

type Output = LockState

The resulting type after applying the | operator.

impl BitOrAssign for LockState

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for LockState

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

type Output = LockState

The resulting type after applying the ^ operator.

impl BitXorAssign for LockState

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for LockState

fn clone(&self) -> LockState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LockState

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

Formats the value using the given formatter.

impl Decode<LockState> for LockState

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_>, offset: usize, _depth: Depth ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for LockState

fn default() -> LockState

Returns the “default value” for a type.

impl Encode<LockState> for LockState

unsafe fn encode( self, encoder: &mut Encoder<'_>, offset: usize, _depth: Depth ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl Extend<LockState> for LockState

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<LockState> for LockState

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for LockState

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 LowerHex for LockState

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

Formats the value using the given formatter.

impl Not for LockState

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = LockState

The resulting type after applying the ! operator.

impl Octal for LockState

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

Formats the value using the given formatter.

impl Ord for LockState

fn cmp(&self, other: &LockState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for LockState

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LockState

fn partial_cmp(&self, other: &LockState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for LockState

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

type Output = LockState

The resulting type after applying the - operator.

impl SubAssign for LockState

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl TypeMarker for LockState

type Owned = LockState

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl UpperHex for LockState

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

Formats the value using the given formatter.

impl ValueTypeMarker for LockState

type Borrowed<'a> = LockState

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow<'a>(value: &'a <Self as TypeMarker>::Owned) -> Self::Borrowed<'a>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Copy for LockState

impl Eq for LockState

impl StructuralEq for LockState

impl StructuralPartialEq for LockState