Struct IOHIDEventSystemClient 

pub struct IOHIDEventSystemClient { /* private fields */ }

Available on crate feature hidsystem only.

IOHIDEventSystemClient

IOHIDEventSystemClient serves as a client that can be used for reading/writing specific properties of the HID event system, as well as getting services of the HID event system. A list of accessible properties can be found in IOKit/hid/IOHIDProperties.h .

See also: IOKit/hidsystem/IOHIDServiceClient.h

See also Apple’s documentation

Implementations

impl IOHIDEventSystemClient

pub fn new_simple_client( allocator: Option<&CFAllocator>, ) -> CFRetained<IOHIDEventSystemClient>

Creates a client of the HID event system that has to ability to read/write certain properties.

Certain properties have the ability to be set/read by clients, see IOHIDProperties.h for a list of these properties.

Parameter allocator: a custom allocator reference to be used for allocation of the result.

Returns: Returns a IOHIDEventSystemClientRef on success. Caller should CFRelease the client when they are finished with it, or keep a reference to the client if multiple properties need to be set/read.

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

Sets a property on the HID event system.

Parameter client: the HID client that created via IOHIDEventSystemClientCreateSimpleClient() .

Parameter key: the property key to set. A list of keys can be found in HIDProperties.h .

Parameter property: the value to set the property.

Returns: Returns true on success.

Safety

property should be of the correct type.

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

Copies a property from the HID event system.

Parameter client: the HID client created via IOHIDEventSystemClientCreateSimpleClient() .

Parameter key: the property key to copy. A list of keys can be found in HIDProperties.h .

Returns: Returns a CFTypeRef of the property to be copied on success, otherwise NULL. Caller is responsible for calling CFRelease on the property.

impl IOHIDEventSystemClient

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

Copies all services available to the client.

Useful for seeing services that are available. Clients can further probe the services with the APIs available in IOHIDServiceClient.h .

Parameter client: the HID client that created via IOHIDEventSystemClientCreateSimpleClient() .

Returns: On success, returns a CFArrayRef of IOHIDServiceClientRefs that are available to the client. Caller is responsible for releasing the array.

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 IOHIDEventSystemClient

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for IOHIDEventSystemClient

fn as_ref(&self) -> &CFType

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

impl AsRef<IOHIDEventSystemClient> for IOHIDEventSystemClient

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for IOHIDEventSystemClient

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for IOHIDEventSystemClient

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for IOHIDEventSystemClient

fn type_id() -> CFTypeID

Returns: Returns the CFTypeID of the IOHIDEventSystemClient class.

impl Debug for IOHIDEventSystemClient

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

Formats the value using the given formatter.

impl Deref for IOHIDEventSystemClient

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for IOHIDEventSystemClient

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 IOHIDEventSystemClient

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for IOHIDEventSystemClient

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 IOHIDEventSystemClient

const ENCODING_REF: Encoding

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

impl Type for IOHIDEventSystemClient

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 IOHIDEventSystemClient