Struct LAEnvironmentState

Source

#[repr(C)]
pub struct LAEnvironmentState { /* private fields */ }

Available on crate feature LAEnvironmentState only.

Expand description

Apple’s documentation

Implementations§

Source §

impl LAEnvironmentState

Source

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

Clients shall not create environment state.

Source

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

Clients shall not create environment state.

Source

pub unsafe fn biometry( &self, ) -> Option<Retained<LAEnvironmentMechanismBiometry>>

Available on crate features LAEnvironmentMechanism and LAEnvironmentMechanismBiometry only.

Information about biometric authentication (Touch ID, Face ID or Optic ID).

nilif biometry is not supported by this device.

Source

pub unsafe fn userPassword( &self, ) -> Option<Retained<LAEnvironmentMechanismUserPassword>>

Available on crate features LAEnvironmentMechanism and LAEnvironmentMechanismUserPassword only.

Information about local user password (on macOS) or passcode (on embedded platforms).

nilif user password or passcode is not supported by this device.

Source

pub unsafe fn companions( &self, ) -> Retained<NSArray<LAEnvironmentMechanismCompanion>>

Available on crate features LAEnvironmentMechanism and LAEnvironmentMechanismCompanion only.

Companion authentication mechanisms.

Companion mechanisms such as Apple Watch can appear and disappear as they get in and out of reach, but this property enumerates paired companions, even if they are not reachable at the moment. Check isUsableproperty to determine if a particular companion type is available for use. Note that items in this array represent paired companion types, not individual devices. Therefore, even if the user has paired multiple Apple Watch devices for companion authentication, the array will contain only one LAEnvironmentMechanimsCompanioninstance of type LACompanionTypeWatch.

Source

pub unsafe fn allMechanisms(&self) -> Retained<NSArray<LAEnvironmentMechanism>>

Available on crate feature LAEnvironmentMechanism only.

Information about all authentication mechanisms.

This property aggregates biometry,``userPassword,``companionsand any future authentication mechanisms.

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.

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