Struct TKTokenSmartCardPINAuthOperation

Source

pub struct TKTokenSmartCardPINAuthOperation { /* private fields */ }

Available on crate features TKSmartCardToken and TKToken only.

Expand description

Context of a SmartCard PIN authentication operation.

Implementations§

Source §

impl TKTokenSmartCardPINAuthOperation

Source

pub unsafe fn PINFormat(&self) -> Retained<TKSmartCardPINFormat>

Available on crate feature TKSmartCard only.

PIN formatting properties.

Note: The property is initialized with a default instance of TKSmartCardPINFormat.

Source

pub unsafe fn setPINFormat(&self, pin_format: &TKSmartCardPINFormat)

Available on crate feature TKSmartCard only.

Setter for PINFormat.

Source

pub unsafe fn APDUTemplate(&self) -> Option<Retained<NSData>>

APDU template into which PIN gets filled in. If set to nil, the system will not attempt to authenticate by sending the formatted APDU to the SmartCard, but rather the token itself is expected to perform the authentication. It is preferred to provide APDUTemplate if possible, because it allows using hardware PINPad for secure PIN entry (provided that the reader has one).

Source

pub unsafe fn setAPDUTemplate(&self, apdu_template: Option<&NSData>)

Setter for APDUTemplate.

This is copied when set.

Source

pub unsafe fn PINByteOffset(&self) -> NSInteger

Offset in bytes within APDU template to mark the location for filling in the PIN.

Source

pub unsafe fn setPINByteOffset(&self, pin_byte_offset: NSInteger)

Setter for PINByteOffset.

Source

pub unsafe fn smartCard(&self) -> Option<Retained<TKSmartCard>>

Available on crate feature TKSmartCard only.

TKSmartCard to which the formatted APDU gets sent in order to authenticate (used only if ‘APDUTemplate’ is set).

Source

pub unsafe fn setSmartCard(&self, smart_card: Option<&TKSmartCard>)

Available on crate feature TKSmartCard only.

Setter for smartCard.

Source

pub unsafe fn PIN(&self) -> Option<Retained<NSString>>

PIN value which will be set when ‘finishWithError:’ gets triggered. Note that the PIN is not set in case that APDUTemplate was set. In this case, PIN was already sent to the card using specified template.

Source

pub unsafe fn setPIN(&self, pin: Option<&NSString>)

Setter for PIN.

This is copied when set.

Source §

impl TKTokenSmartCardPINAuthOperation

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = TKTokenAuthOperation>§

Source

pub unsafe fn finishWithError(&self) -> Result<(), Retained<NSError>>

Handler triggered by the system in order to let the token finalize the authentication operation.

Parameter error: Error details (see TKError.h).

Returns: Finalization status.

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}