Struct TKSmartCard 

pub struct TKSmartCard { /* private fields */ }

Available on crate feature TKSmartCard only.

Represents SmartCard inserted in the slot. Once the card is physically removed from the slot, the session object is invalid and will always fail the operation invoked on it. In order to communicate with the card, an exclusive session must be established.

See also Apple’s documentation

Implementations

impl TKSmartCard

pub unsafe fn slot(&self) -> Retained<TKSmartCardSlot>

Slot in which is this card inserted.

pub unsafe fn valid(&self) -> bool

Flag indicating whether card is valid, i.e. it was not removed from the reader. Use Key-Value-Observing to be notified about card removal.

pub unsafe fn allowedProtocols(&self) -> TKSmartCardProtocol

Available on crate feature TKSmartCardATR only.

Bitmask containing allowed protocols to be used when communicating with the card. This property is consulted only during connection to the card, changes are not propagated to already connected session. By default, any protocol can be used.

pub unsafe fn setAllowedProtocols(&self, allowed_protocols: TKSmartCardProtocol)

Available on crate feature TKSmartCardATR only.

Setter for allowedProtocols.

pub unsafe fn currentProtocol(&self) -> TKSmartCardProtocol

Available on crate feature TKSmartCardATR only.

Protocol used for communication with the SmartCard. If no card session is established, TKSmartCardProtocolNone is set.

pub unsafe fn sensitive(&self) -> bool

Flag indicating whether card session should be considered as sensitive. Sensitive session always gets card after reset before communicating with it and never leaves card without reset to be used by another SmartCard object. This might be important in case that card session contain some important state which should not leak to another SmartCard object (possibly running in another, foreign application). Default is NO.

pub unsafe fn setSensitive(&self, sensitive: bool)

Setter for sensitive.

pub unsafe fn context(&self) -> Option<Retained<AnyObject>>

User-specified context kept as long as the card is powered. Once the card is removed or another TKSmartCard object opens session, this property is automatically set to nil.

pub unsafe fn setContext(&self, context: Option<&AnyObject>)

Setter for context.

Safety

context should be of the correct type.

pub unsafe fn beginSessionWithReply( &self, reply: &DynBlock<dyn Fn(Bool, *mut NSError)>, )

Available on crate feature block2 only.

Begins session with the card.

When session exists, other requests for sessions from other card objects to the same card are blocked. Session is reference-counted, the same amount of ‘end’ calls must be done to really terminate the session. Note that finishing session does not automatically mean that the card is disconnected; it only happens when another session from different card object is requested.

Parameter success: Signals whether session was successfully started.

Parameter error: More information about error preventing the transaction to start

pub unsafe fn transmitRequest_reply( &self, request: &NSData, reply: &DynBlock<dyn Fn(*mut NSData, *mut NSError)>, )

Available on crate feature block2 only.

Transmits raw command to the card. This call is allowed only inside session.

Parameter request: Request part of APDU

Parameter reponse: Response part of APDU, or nil if communication with the card failed

Parameter error: Error details when communication with the card failed

pub unsafe fn endSession(&self)

Terminates the transaction. If no transaction is pending any more, the connection will be closed if there is another session in the system waiting for the transaction.

pub unsafe fn userInteractionForSecurePINVerificationWithPINFormat_APDU_PINByteOffset( &self, pin_format: &TKSmartCardPINFormat, apdu: &NSData, pin_byte_offset: NSInteger, ) -> Option<Retained<TKSmartCardUserInteractionForSecurePINVerification>>

Creates a new user interaction object for secure PIN verification using the SmartCard reader facilities (typically a HW keypad).

Note: This interaction is only allowed within a session.

Parameter PINFormat: PIN format descriptor.

Parameter APDU: Predefined APDU in which the SmartCard reader fills in the PIN.

Parameter PINByteOffset: Offset in bytes within APDU data field to mark a location of a PIN block for filling in the entered PIN (currently unused, must be 0).

Returns: A new user interaction object, or nil if this feature is not supported by the SmartCard reader. After the interaction has been successfully completed the operation result is available in the result properites.

pub unsafe fn userInteractionForSecurePINChangeWithPINFormat_APDU_currentPINByteOffset_newPINByteOffset( &self, pin_format: &TKSmartCardPINFormat, apdu: &NSData, current_pin_byte_offset: NSInteger, new_pin_byte_offset: NSInteger, ) -> Option<Retained<TKSmartCardUserInteractionForSecurePINChange>>

Creates a new user interaction object for secure PIN change using the SmartCard reader facilities (typically a HW keypad).

Note: This interaction is only allowed within a session.

Parameter PINFormat: PIN format descriptor.

Parameter APDU: Predefined APDU in which the SmartCard reader fills in the PIN(s).

Parameter currentPINByteOffset: Offset in bytes within APDU data field to mark a location of a PIN block for filling in the current PIN.

Parameter newPINByteOffset: Offset in bytes within APDU data field to mark a location of a PIN block for filling in the new PIN.

Returns: A new user interaction object, or nil if this feature is not supported by the SmartCard reader. After the interaction has been successfully completed the operation result is available in the result properites.

impl TKSmartCard

Methods declared on superclass NSObject.

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

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

impl TKSmartCard

APDULevelTransmit.

Extension of base TKSmartCard interface implementing ISO7816-3 and ISO7816-4 structured APDU transmission.

pub unsafe fn cla(&self) -> u8

CLA byte which will be used for sendIns: APDU transmits. Default value is 0x00.

pub unsafe fn setCla(&self, cla: u8)

Setter for cla.

pub unsafe fn useExtendedLength(&self) -> bool

Flag indicating whether extended length APDUs should be used. It is automatically enabled only when used slot supports transmitting extended length commands and card announces that extended length APDU are supported in its ATR. However, caller can explicitly override this decision.

pub unsafe fn setUseExtendedLength(&self, use_extended_length: bool)

Setter for useExtendedLength.

pub unsafe fn useCommandChaining(&self) -> bool

Flag indicating whether command chaining of APDU with data field longer than 255 bytes can be used. It is automatically enabled when card announces that command chaining is supported in its ATR. However, caller can explicitly override this decision.

pub unsafe fn setUseCommandChaining(&self, use_command_chaining: bool)

Setter for useCommandChaining.

pub unsafe fn sendIns_p1_p2_data_le_reply( &self, ins: u8, p1: u8, p2: u8, request_data: Option<&NSData>, le: Option<&NSNumber>, reply: &DynBlock<dyn Fn(*mut NSData, u16, *mut NSError)>, )

Available on crate feature block2 only.

Transmits APDU to the card and returns response.

Asynchronous high level variant of command for transmitting APDU to the card. Handles all ISO7816-4 APDU cases translation to proper sequences according to used protocol. Consults useExtendedAPDU and useCommandChaining properties and uses these modes whenever appropriate and beneficial for sending requested APDU request.

Parameter ins: INS code of the APDU

Parameter p1: P1 code of the APDU

Parameter p2: P2 code of the APDU

Parameter requestData: Data field of the APDU, or nil if no input data field should be present (i.e case1 or case2 APDUs). Length of the data serves as Lc field of the APDU.

Parameter le: Expected number of bytes to be returned, or nil if no output data are expected (i.e. case1 or case3 APDUs). To get as much bytes as card provides, pass @ 0.

Parameter replyData: Block of returned data without SW1SW2 bytes, or nil if an error occured.

Parameter sw: SW1SW2 result code, first two bytes of returned card’s reply.

Parameter error: Contains error details when nil is returned. Specific error is also filled in if there was no communication error, but card returned other SW code than 0x9000.

pub unsafe fn inSessionWithError_executeBlock( &self, error: Option<&mut Option<Retained<NSError>>>, block: &DynBlock<dyn Fn(*mut *mut NSError) -> Bool>, ) -> bool

Available on crate feature block2 only.

Synchronous variant of session creation. Begins the session, executes given block and ends session.

Parameter error: Error receiving more information when transaction failed to start or block failed for some reason.

Parameter block: Block to be executed when the session was successfully begun.

Returns: Returns YES if the session was successfully begun and block returned YES, otherwise NO.

pub unsafe fn sendIns_p1_p2_data_le_sw_error( &self, ins: u8, p1: u8, p2: u8, request_data: Option<&NSData>, le: Option<&NSNumber>, sw: NonNull<u16>, ) -> Result<Retained<NSData>, Retained<NSError>>

Transmits APDU to the card and returns response.

Synchronous high level variant of command for transmitting APDU to the card. Handles all ISO7816-4 APDU cases translation to proper sequences according to used protocol. Should be used in block passed to -[TKSmartCard inSessionWithError:executeBlock:] method.

Parameter ins: INS code of the APDU

Parameter p1: P1 code of the APDU

Parameter p2: P2 code of the APDU

Parameter data: Data field of the APDU. Length of the data serves as Lc field of the APDU

Parameter le: Expected number of bytes to be returned, or nil if no output data are expected (i.e. case1 or case3 APDUs). To get as much bytes as card provides, pass @ 0.

Parameter sw: On output, filled with SW1SW2 result code

Parameter error: Contains error details when nil is returned. Specific error is also filled in if there was no communication error, but card returned other SW code than 0x9000.

Returns: Returned data field, excluding SW status bytes. If an error occured, returns nil.

Safety

sw must be a valid pointer.

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

Available on crate feature TKToken only.

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.

Available on crate feature TKToken only.

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,

Available on crate feature TKToken only.

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 TKSmartCard

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for TKSmartCard

fn as_ref(&self) -> &NSObject

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

impl AsRef<TKSmartCard> for TKSmartCard

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for TKSmartCard

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for TKSmartCard

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for TKSmartCard

const NAME: &'static str = "TKSmartCard"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<TKSmartCard 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 TKSmartCard

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

Formats the value using the given formatter.

impl Deref for TKSmartCard

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for TKSmartCard

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 TKSmartCard

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for TKSmartCard

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 TKSmartCard

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 TKSmartCard

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

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

impl DowncastTarget for TKSmartCard

impl Eq for TKSmartCard