Struct IOUSBHostCIEndpointStateMachine 

pub struct IOUSBHostCIEndpointStateMachine { /* private fields */ }

Available on crate feature IOUSBHostCIEndpointStateMachine only.

The object representing the state of a user-mode USB host controller endpoint

This class assists with tracking internal state transitions of a user-mode USB host controller endpoint, and parses IOUSBHostCIMessage command structures to update state and generate properly formatted command responses. Clients should create an IOUSBHostCIEndpointStateMachine in response to an IOUSBHostCIMessageTypeEndpointCreate command, and then use the provided interfaces to identify and process commands, doorbells, and transfer structures for the endpoint. The IOUSBHostCIEndpointStateMachine should be destroyed in response to an IOUSBHostCIMessageTypeEndpointDestroy command.

Endpoint state is controlled by IOUSBHostCIMessage structures representing commands and transfer completions, and IOUSBHostCIDoorbell messages. Only an endpoint in the IOUSBHostCIEndpointStateActive state may inspect transfer structures, read or modify IO buffers, and generate transfer completions.

IOUSBHostCIEndpointStateMachine does not provide any concurrency protection, the client is responsible for necessary serialization.

See also Apple’s documentation

Implementations

impl IOUSBHostCIEndpointStateMachine

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn initWithInterface_command_error( this: Allocated<Self>, interface: &IOUSBHostControllerInterface, command: NonNull<IOUSBHostCIMessage>, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features IOUSBHostControllerInterface and IOUSBHostControllerInterfaceDefinitions only.

Initializes an IOUSBHostCIEndpointStateMachine object

The IOUSBHostCIEndpointStateMachine defaults to the IOUSBHostCIEndpointStatePaused state.

Parameter interface: IOUSBHostControllerInterface which will be used to send command responses.

Parameter command: IOUSBHostCIMessage with type IOUSBHostCIMessageTypeEndpointCreate

Returns: IOUSBHostCIEndpointStateMachine instance, to be released by the caller.

Safety

command must be a valid pointer.

pub unsafe fn inspectCommand_error( &self, command: NonNull<IOUSBHostCIMessage>, ) -> Result<(), Retained<NSError>>

Available on crate feature IOUSBHostControllerInterfaceDefinitions only.

Inspect an IOUSBHostCIMessage command

The IOUSBHostCIMessage command is inspected to determine if it is handled by this state machine and is appropriate for the current state.

Parameter command: IOUSBHostCIMessage command structure received from the kernel driver.

Returns: BOOL YES if the command is targeting this endpoint, and can be handled in the current state BOOL NO if the command does not target this endpoint, or cannot be handled in the current state

Safety

command must be a valid pointer.

pub unsafe fn respondToCommand_status_error( &self, command: NonNull<IOUSBHostCIMessage>, status: IOUSBHostCIMessageStatus, ) -> Result<(), Retained<NSError>>

Available on crate feature IOUSBHostControllerInterfaceDefinitions only.

Advance the state machine and respond to an IOUSBHostCIMessage command

If the command passes inspectCommand and the client indicates the command was processed successfully, endpointState is updated and a properly formatted command response message is sent to the kernel driver. If the client indicates the command was not processed successfully, endpointState is not updated but a properly formatted command response message is sent to the kernel driver.

Parameter command: IOUSBHostCIMessage command structure received from the kernel driver.

Parameter status: IOUSBHostCIMessageStatus reported by the user-mode USB host controller implementation for the command response.

Returns: BOOL YES if the command response was sent to the kernel driver BOOL NO if the command response was not sent to the kernel driver

Safety

command must be a valid pointer.

pub unsafe fn processDoorbell_error( &self, doorbell: IOUSBHostCIDoorbell, ) -> Result<(), Retained<NSError>>

Available on crate feature IOUSBHostControllerInterfaceDefinitions only.

Advance the state machine and process an IOUSBHostCIDoorbell message

The IOUSBHostCIDoorbell is inspected to determine if it is handled by this state machine and is appropriate for the current state. If successful, the client should check for an IOUSBHostCIEndpointStateActive endpointState and a currentTransferMessage with IOUSBHostCIMessageControlValid set to determine if more IOUSBHostCIMessages should be processed.

Parameter doorbell: IOUSBHostCIDoorbell message received from the kernel driver.

Returns: BOOL YES if the doorbell is targeting this endpoint and can be handled in the current state. BOOL NO is the doorbell does not target this endpoint or cannot be handled in the current state.

pub unsafe fn enqueueTransferCompletionForMessage_status_transferLength_error( &self, message: NonNull<IOUSBHostCIMessage>, status: IOUSBHostCIMessageStatus, transfer_length: NSUInteger, ) -> Result<(), Retained<NSError>>

Available on crate feature IOUSBHostControllerInterfaceDefinitions only.

Send an IOUSBHostCIMessage representing a transfer completion to the kernel, and advance the state machine

When a client has processed an IOUSBHostCIMessage representing a transfer, the result is reported to the kernel by another IOUSBHostCIMessage. If successful, this object will use controllerInterface’s enqueueInterrupt interface to send a properly formatted IOUSBHostCIMessage to the kernel with IOUSBHostCITransferCompletionMessageData1TransferStructure populated with currentTransferMessage’s virtual address, and endpointState and currentTransferMessage are updated. After a successful call, the client should check for an IOUSBHostCIEndpointStateActive endpointState and a currentTransferMessage with IOUSBHostCIMessageControlValid set to determine if more IOUSBHostCIMessages should be processed.

Parameter message: pointer to the IOUSBHostCIMessage which generated this tranafer completion message. This must match currentTransferMessage to be successful.

Parameter status: IOUSBHostCIMessageStatus

Parameter transferLength: The number of bytes transferred for the specified transfer structure.

Safety

message must be a valid pointer.

pub unsafe fn endpointState(&self) -> IOUSBHostCIEndpointState

Available on crate feature IOUSBHostControllerInterfaceDefinitions only.

pub unsafe fn deviceAddress(&self) -> NSUInteger

pub unsafe fn endpointAddress(&self) -> NSUInteger

pub unsafe fn currentTransferMessage(&self) -> NonNull<IOUSBHostCIMessage>

Available on crate feature IOUSBHostControllerInterfaceDefinitions only.

pub unsafe fn controllerInterface( &self, ) -> Retained<IOUSBHostControllerInterface>

Available on crate feature IOUSBHostControllerInterface only.

impl IOUSBHostCIEndpointStateMachine

Methods declared on superclass NSObject.

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

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

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for IOUSBHostCIEndpointStateMachine

fn as_ref(&self) -> &AnyObject

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

impl AsRef<IOUSBHostCIEndpointStateMachine> for IOUSBHostCIEndpointStateMachine

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for IOUSBHostCIEndpointStateMachine

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for IOUSBHostCIEndpointStateMachine

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for IOUSBHostCIEndpointStateMachine

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for IOUSBHostCIEndpointStateMachine

const NAME: &'static str = "IOUSBHostCIEndpointStateMachine"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<IOUSBHostCIEndpointStateMachine as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for IOUSBHostCIEndpointStateMachine

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

Formats the value using the given formatter.

impl Deref for IOUSBHostCIEndpointStateMachine

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for IOUSBHostCIEndpointStateMachine

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 IOUSBHostCIEndpointStateMachine

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for IOUSBHostCIEndpointStateMachine

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for IOUSBHostCIEndpointStateMachine

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 IOUSBHostCIEndpointStateMachine

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

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

impl DowncastTarget for IOUSBHostCIEndpointStateMachine

impl Eq for IOUSBHostCIEndpointStateMachine