Struct TKTokenKeychainKey 

pub struct TKTokenKeychainKey { /* private fields */ }

Available on crate feature TKTokenKeychainItem only.

Interface for propagation token’s keys into the keychain.

See also Apple’s documentation

Implementations

impl TKTokenKeychainKey

pub unsafe fn initWithCertificate_objectID( this: Allocated<Self>, certificate_ref: Option<&SecCertificate>, object_id: &TKTokenObjectID, ) -> Option<Retained<Self>>

Available on crate features TKToken and objc2-security only.

Initialize TKTokenKeychainKey with informations from SecCertificateRef associated with the key. Use SecCertificateCreateWithData to obtain SecCertificateRef. If NULL is passed instead of certificate, all properties of created instance must be initialized manually.

Safety

object_id should be of the correct type.

pub unsafe fn initWithObjectID( this: Allocated<Self>, object_id: &TKTokenObjectID, ) -> Retained<Self>

Available on crate feature TKToken only.

Safety

object_id should be of the correct type.

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

Type of the key, currently kSecAttrKeyTypeRSA and kSecAttrKeyTypeECSECPrimeRandom is supported). The property is an equivalent to kSecAttrKeyType in SecItem.h

pub unsafe fn setKeyType(&self, key_type: &NSString)

Setter for keyType.

This is copied when set.

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

Represents private tag data. The property is an equivalent to kSecAttrApplicationTag in SecItem.h

pub unsafe fn setApplicationTag(&self, application_tag: Option<&NSData>)

Setter for applicationTag.

This is copied when set.

pub unsafe fn keySizeInBits(&self) -> NSInteger

Indicates the number of bits in this key. The property is an equivalent to kSecAttrKeySizeInBits in SecItem.h

pub unsafe fn setKeySizeInBits(&self, key_size_in_bits: NSInteger)

Setter for keySizeInBits.

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

Contains raw public key data for this private key.

pub unsafe fn setPublicKeyData(&self, public_key_data: Option<&NSData>)

Setter for publicKeyData.

This is copied when set.

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

SHA1 hash of the raw public key. The property is an equivalent to kSecAttrApplicationLabel in SecItem.h

pub unsafe fn setPublicKeyHash(&self, public_key_hash: Option<&NSData>)

Setter for publicKeyHash.

This is copied when set.

pub unsafe fn canDecrypt(&self) -> bool

Indicates whether this key can be used to decrypt data. The property is an equivalent to kSecAttrCanDecrypt in SecItem.h

pub unsafe fn setCanDecrypt(&self, can_decrypt: bool)

Setter for canDecrypt.

pub unsafe fn canSign(&self) -> bool

Indicates whether this key can be used to create a digital signature. The property is an equivalent to kSecAttrCanSign in SecItem.h

pub unsafe fn setCanSign(&self, can_sign: bool)

Setter for canSign.

pub unsafe fn canPerformKeyExchange(&self) -> bool

Indicates whether this key can be used to perform Diffie-Hellman style cryptographic key exchange.

pub unsafe fn setCanPerformKeyExchange(&self, can_perform_key_exchange: bool)

Setter for canPerformKeyExchange.

pub unsafe fn isSuitableForLogin(&self) -> bool

Indicates whether this key can be used for login in to the system.

pub unsafe fn setSuitableForLogin(&self, suitable_for_login: bool)

Setter for isSuitableForLogin.

impl TKTokenKeychainKey

Methods declared on superclass TKTokenKeychainItem.

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

impl TKTokenKeychainKey

Methods declared on superclass NSObject.

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

Methods from Deref<Target = TKTokenKeychainItem>

pub unsafe fn objectID(&self) -> Retained<TKTokenObjectID>

Available on crate feature TKToken only.

object ID for item identification

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

Contains the user-visible label for this item. This property is an equivalent of kSecAttrLabel in SecItem.h

pub unsafe fn setLabel(&self, label: Option<&NSString>)

Setter for label.

This is copied when set.

pub unsafe fn constraints( &self, ) -> Option<Retained<NSDictionary<NSNumber, TKTokenOperationConstraint>>>

Available on crate feature TKToken only.

Contains access constraints for this object keyed by TKTOpenOperation wrapped in NSNumber.

pub unsafe fn setConstraints( &self, constraints: Option<&NSDictionary<NSNumber, TKTokenOperationConstraint>>, )

Available on crate feature TKToken only.

Setter for constraints.

This is copied when set.

Safety

constraints generic should be of the correct type.

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 TKTokenKeychainKey

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for TKTokenKeychainKey

fn as_ref(&self) -> &NSObject

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

impl AsRef<TKTokenKeychainItem> for TKTokenKeychainKey

fn as_ref(&self) -> &TKTokenKeychainItem

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

impl AsRef<TKTokenKeychainKey> for TKTokenKeychainKey

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for TKTokenKeychainKey

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for TKTokenKeychainKey

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<TKTokenKeychainItem> for TKTokenKeychainKey

fn borrow(&self) -> &TKTokenKeychainItem

Immutably borrows from an owned value.

impl ClassType for TKTokenKeychainKey

const NAME: &'static str = "TKTokenKeychainKey"

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

type Super = TKTokenKeychainItem

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for TKTokenKeychainKey

type Target = TKTokenKeychainItem

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for TKTokenKeychainKey

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 TKTokenKeychainKey

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for TKTokenKeychainKey

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 TKTokenKeychainKey

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 TKTokenKeychainKey

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

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

impl DowncastTarget for TKTokenKeychainKey

impl Eq for TKTokenKeychainKey