Struct TKSmartCardATR

Source

pub struct TKSmartCardATR { /* private fields */ }

Available on crate feature TKSmartCardATR only.

Expand description

Represents parsed SmartCard ATR. Provides routine for parsing byte stream or NSData with binary ATR and accessors to parsed ATR parts.

Implementations§

Source §

impl TKSmartCardATR

Source

pub unsafe fn initWithBytes( this: Allocated<Self>, bytes: &NSData, ) -> Option<Retained<Self>>

Parses ATR from binary data block

Parameter bytes: Data containing full valid ATR

Returns: Parsed ATR instance, or nil when #bytes do not contain valid ATR.

Source

pub unsafe fn initWithSource( this: Allocated<Self>, source: &DynBlock<dyn Fn() -> c_int>, ) -> Option<Retained<Self>>

Available on crate feature block2 only.

Parses ATR from stream.

Parameter source: Provides one byte of ATR from the stream or -1 in case of an error

Returns: Parsed ATR instance, or nil when #source method failed or an invalid ATR is detected

Source

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

Full ATR as string of bytes

Source

pub unsafe fn protocols(&self) -> Retained<NSArray<NSNumber>>

Array of NSNumber of protocols indicated in ATR, in the correct order (i.e. the default protocol comes first), duplicates sorted out.

Source

pub unsafe fn interfaceGroupAtIndex( &self, index: NSInteger, ) -> Option<Retained<TKSmartCardATRInterfaceGroup>>

Retrieves interface group with specified index.

Parameter index: Index of the requested interface group. Indexing conforms to ISO7816-3, i.e. starts from 1.

Returns: Interface group with given index, or nil of no such group was present.

Source

pub unsafe fn interfaceGroupForProtocol( &self, protocol: TKSmartCardProtocol, ) -> Option<Retained<TKSmartCardATRInterfaceGroup>>

Parameter protocol: Protocol number for which the interface group is requested.

Source

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

Just historical bytes of ATR, without Tck and interface bytes.

Source

pub unsafe fn historicalRecords( &self, ) -> Option<Retained<NSArray<TKCompactTLVRecord>>>

Available on crate feature TKTLVRecord only.

An array of TKCompactTLVRecord instances with TLV records parsed from historical bytes. If historical bytes are not structured using Compact TLV encoding, nil is returned.

Note: In case that ATR historical bytes begin with 0x00, the last three bytes (status indicator) are automatically appended into the returned records as if historical bytes would begin with 0x80 and 0x8 record is present in historical bytes.

Source §

impl TKSmartCardATR

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 = 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

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

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.

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.

Source

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