Struct IOHIDValue 

pub struct IOHIDValue { /* private fields */ }

Available on crate feature hid only.

This is the type of a reference to the IOHIDValue.

See also Apple’s documentation

Implementations

impl IOHIDValue

pub fn with_integer_value( allocator: Option<&CFAllocator>, element: &IOHIDElement, time_stamp: u64, value: CFIndex, ) -> CFRetained<IOHIDValue>

Creates a new element value using an integer value.

IOHIDValueGetTimeStamp should represent OS AbsoluteTime, not CFAbsoluteTime. To obtain the OS AbsoluteTime, please reference the APIs declared in <mach /mach_time.h>

Parameter allocator: The CFAllocator which should be used to allocate memory for the value. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined.

Parameter element: IOHIDElementRef associated with this value.

Parameter timeStamp: OS absolute time timestamp for this value.

Parameter value: Integer value to be copied to this object.

Returns: Returns a reference to a new IOHIDValueRef.

pub unsafe fn with_bytes( allocator: Option<&CFAllocator>, element: &IOHIDElement, time_stamp: u64, bytes: NonNull<u8>, length: CFIndex, ) -> Option<CFRetained<IOHIDValue>>

Creates a new element value using byte data.

IOHIDValueGetTimeStamp should represent OS AbsoluteTime, not CFAbsoluteTime. To obtain the OS AbsoluteTime, please reference the APIs declared in <mach /mach_time.h>

Parameter allocator: The CFAllocator which should be used to allocate memory for the value. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined.

Parameter element: IOHIDElementRef associated with this value.

Parameter timeStamp: OS absolute time timestamp for this value.

Parameter bytes: Pointer to a buffer of uint8_t to be copied to this object.

Parameter length: Number of bytes in the passed buffer.

Returns: Returns a reference to a new IOHIDValueRef.

Safety

bytes must be a valid pointer.

pub unsafe fn with_bytes_no_copy( allocator: Option<&CFAllocator>, element: &IOHIDElement, time_stamp: u64, bytes: NonNull<u8>, length: CFIndex, ) -> Option<CFRetained<IOHIDValue>>

Creates a new element value using byte data without performing a copy.

The timestamp value passed should represent OS AbsoluteTime, not CFAbsoluteTime. To obtain the OS AbsoluteTime, please reference the APIs declared in <mach /mach_time.h>

Parameter allocator: The CFAllocator which should be used to allocate memory for the value. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined.

Parameter element: IOHIDElementRef associated with this value.

Parameter timeStamp: OS absolute time timestamp for this value.

Parameter bytes: Pointer to a buffer of uint8_t to be referenced by this object.

Parameter length: Number of bytes in the passed buffer.

Returns: Returns a reference to a new IOHIDValueRef.

Safety

bytes must be a valid pointer.

pub fn element(&self) -> CFRetained<IOHIDElement>

Returns the element value associated with this IOHIDValueRef.

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

Returns: Returns a IOHIDElementRef referenced by this value.

pub fn time_stamp(&self) -> u64

Returns the timestamp value contained in this IOHIDValueRef.

The timestamp value returned represents OS AbsoluteTime, not CFAbsoluteTime.

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

Returns: Returns a uint64_t representing the timestamp of this value.

pub fn length(&self) -> CFIndex

Returns the size, in bytes, of the value contained in this IOHIDValueRef.

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

Returns: Returns length of the value.

pub fn byte_ptr(&self) -> NonNull<u8>

Returns a byte pointer to the value contained in this IOHIDValueRef.

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

Returns: Returns a pointer to the value.

pub fn integer_value(&self) -> CFIndex

Returns an integer representaion of the value contained in this IOHIDValueRef.

The value is based on the logical element value contained in the report returned by the device.

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

Returns: Returns an integer representation of the value.

pub fn scaled_value(&self, type: IOHIDValueScaleType) -> c_double

Returns an scaled representaion of the value contained in this IOHIDValueRef based on the scale type.

The scaled value is based on the range described by the scale type’s min and max, such that:
scaledValue = ((value - min) * (scaledMax - scaledMin) / (max - min)) + scaledMin
Note:
There are currently two types of scaling that can be applied:

• kIOHIDValueScaleTypePhysical : Scales element value using the physical bounds of the device such that scaledMin = physicalMin and scaledMax = physicalMax .
• kIOHIDValueScaleTypeCalibrated : Scales element value such that scaledMin = -1 and scaledMax = 1 . This value will also take into account the calibration properties associated with this element.

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

Parameter type: The type of scaling to be performed.

Returns: Returns an scaled floating point representation of the value.

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 IOHIDValue

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for IOHIDValue

fn as_ref(&self) -> &CFType

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

impl AsRef<IOHIDValue> for IOHIDValue

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for IOHIDValue

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for IOHIDValue

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for IOHIDValue

fn type_id() -> CFTypeID

Returns the type identifier of all IOHIDValue instances.

impl Debug for IOHIDValue

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

Formats the value using the given formatter.

impl Deref for IOHIDValue

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for IOHIDValue

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 IOHIDValue

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for IOHIDValue

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 IOHIDValue

const ENCODING_REF: Encoding

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

impl Type for IOHIDValue

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 IOHIDValue