Struct IOHIDElement 

pub struct IOHIDElement { /* private fields */ }

Available on crate feature hid only.

This is the type of a reference to the IOHIDElement.

See also Apple’s documentation

Implementations

impl IOHIDElement

pub unsafe fn with_dictionary( allocator: Option<&CFAllocator>, dictionary: &CFDictionary, ) -> CFRetained<IOHIDElement>

Creates an element from a dictionary.

The dictionary should contain keys defined in IOHIDKeys.h and start with kIOHIDElement. This call is meant be used by a IOHIDDeviceDeviceInterface object.

Parameter allocator: Allocator to be used during creation.

Parameter dictionary: dictionary containing values in which to create element.

Returns: Returns a new IOHIDElementRef.

Safety

dictionary generics must be of the correct type.

pub fn device(&self) -> CFRetained<IOHIDDevice>

Obtain the device associated with the element.

Parameter element: IOHIDElement to be queried.

Returns: Returns the a reference to the device.

pub fn parent(&self) -> Option<CFRetained<IOHIDElement>>

Returns the parent for the element.

The parent element can be an element of type kIOHIDElementTypeCollection.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns an IOHIDElementRef referencing the parent element.

pub fn children(&self) -> Option<CFRetained<CFArray>>

Returns the children for the element.

An element of type kIOHIDElementTypeCollection usually contains children.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns an CFArrayRef containing element objects of type IOHIDElementRef.

pub fn attach(&self, to_attach: &IOHIDElement)

Establish a relationship between one or more elements.

This is useful for grouping HID elements with related functionality.

Parameter element: The element to be modified. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Parameter toAttach: The element to be attached. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

pub fn detach(&self, to_detach: &IOHIDElement)

Remove a relationship between one or more elements.

This is useful for grouping HID elements with related functionality.

Parameter element: The element to be modified. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Parameter toDetach: The element to be detached. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

pub fn attached(&self) -> Option<CFRetained<CFArray>>

Obtain attached elements.

Attached elements are those that have been grouped via IOHIDElementAttach.

Parameter element: The element to be modified. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns a copy of the current attached elements.

pub fn cookie(&self) -> IOHIDElementCookie

Retrieves the cookie for the element.

The IOHIDElementCookie represent a unique identifier for an element within a device.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the IOHIDElementCookie for the element.

pub fn type(&self) -> IOHIDElementType

Retrieves the type for the element.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the IOHIDElementType for the element.

pub fn collection_type(&self) -> IOHIDElementCollectionType

Retrieves the collection type for the element.

The value returned by this method only makes sense if the element type is kIOHIDElementTypeCollection.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the IOHIDElementCollectionType for the element.

pub fn usage_page(&self) -> u32

Retrieves the usage page for an element.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the usage page for the element.

pub fn usage(&self) -> u32

Retrieves the usage for an element.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the usage for the element.

pub fn is_virtual(&self) -> bool

Returns the virtual property for the element.

Indicates whether the element is a virtual element.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the TRUE if virtual or FALSE if not.

pub fn is_relative(&self) -> bool

Returns the relative property for the element.

Indicates whether the data is relative (indicating the change in value from the last report) or absolute (based on a fixed origin).

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns TRUE if relative or FALSE if absolute.

pub fn is_wrapping(&self) -> bool

Returns the wrap property for the element.

Wrap indicates whether the data “rolls over” when reaching either the extreme high or low value.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns TRUE if wrapping or FALSE if non-wrapping.

pub fn is_array(&self) -> bool

Returns the array property for the element.

Indicates whether the element represents variable or array data values. Variable values represent data from a physical control. An array returns an index in each field that corresponds to the pressed button (like keyboard scan codes).
Note: The HID Manager will represent most elements as “variable” including the possible usages of an array. Array indices will remain as “array” elements with a usage of 0xffffffff.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns TRUE if array or FALSE if variable.

pub fn is_non_linear(&self) -> bool

Returns the linear property for the element.

Indicates whether the value for the element has been processed in some way, and no longer represents a linear relationship between what is measured and the value that is reported.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns TRUE if non linear or FALSE if linear.

pub fn has_preferred_state(&self) -> bool

Returns the preferred state property for the element.

Indicates whether the element has a preferred state to which it will return when the user is not physically interacting with the control.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns TRUE if preferred state or FALSE if no preferred state.

pub fn has_null_state(&self) -> bool

Returns the null state property for the element.

Indicates whether the element has a state in which it is not sending meaningful data.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns TRUE if null state or FALSE if no null state.

pub fn name(&self) -> CFRetained<CFString>

Returns the name for the element.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns CFStringRef containing the element name.

pub fn report_id(&self) -> u32

Returns the report ID for the element.

The report ID represents what report this particular element belongs to.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the report ID.

pub fn report_size(&self) -> u32

Returns the report size in bits for the element.

If the element is an array type the total number of bit in the element is equal to IOHIDElementGetReportSize(element) * IOHIDElementGetReportCount(element). Otherwise this size is the total number of bits in the element.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the report size.

pub fn report_count(&self) -> u32

Returns the report count for the element.

If the IOHIDElementGetReportCount(element) is greater than one and the element does not represent an array then the element represents a repeated set of usages, the size of each usage in the element is IOHIDElementGetReportSize(element) / IOHIDElementGetReportCount(element).

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the report count.

pub fn unit(&self) -> u32

Returns the unit property for the element.

The unit property is described in more detail in Section 6.2.2.7 of the “Device Class Definition for Human Interface Devices(HID)” Specification, Version 1.11.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the unit.

pub fn unit_exponent(&self) -> u32

Returns the code associated with the unit exponent as outlined in the HID spec

The unit exponent property is described in more detail in Section 6.2.2.7 of the “Device Class Definition for Human Interface Devices(HID)” Specification, Version 1.11.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the unit exponent.

pub fn logical_min(&self) -> CFIndex

Returns the minimum value possible for the element.

This corresponds to the logical minimun, which indicates the lower bounds of a variable element.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the logical minimum.

pub fn logical_max(&self) -> CFIndex

Returns the maximum value possible for the element.

This corresponds to the logical maximum, which indicates the upper bounds of a variable element.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the logical maximum.

pub fn physical_min(&self) -> CFIndex

Returns the scaled minimum value possible for the element.

Minimum value for the physical extent of a variable element. This represents the value for the logical minimum with units applied to it.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the physical minimum.

pub fn physical_max(&self) -> CFIndex

Returns the scaled maximum value possible for the element.

Maximum value for the physical extent of a variable element. This represents the value for the logical maximum with units applied to it.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Returns: Returns the physical maximum.

pub fn property(&self, key: &CFString) -> Option<CFRetained<CFType>>

Returns the an element property.

Property keys are prefixed by kIOHIDElement and declared in IOHIDKeys.h.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Parameter key: The key to be used when querying the element.

Returns: Returns the property.

pub unsafe fn set_property(&self, key: &CFString, property: &CFType) -> bool

Sets an element property.

This method can be used to set arbitrary element properties, such as application specific references.

Parameter element: The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.

Parameter key: The key to be used when querying the element.

Returns: Returns TRUE if successful.

Safety

property should be of the correct type.

Methods from Deref<Target = CFType>

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: ConcreteType,

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for IOHIDElement

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<CFType> for IOHIDElement

fn as_ref(&self) -> &CFType

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<IOHIDElement> for IOHIDElement

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for IOHIDElement

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for IOHIDElement

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for IOHIDElement

fn type_id() -> CFTypeID

Returns the type identifier of all IOHIDElement instances.

impl Debug for IOHIDElement

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

Formats the value using the given formatter.

impl Deref for IOHIDElement

type Target = CFType

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for IOHIDElement

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 Message for IOHIDElement

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for IOHIDElement

fn eq(&self, other: &Self) -> 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 RefEncode for IOHIDElement

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Type for IOHIDElement

fn retain(&self) -> CFRetained<Self>

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for IOHIDElement