#[repr(C)]pub struct LAEnvironmentMechanismBiometry { /* private fields */ }
LAEnvironmentMechanism
and LAEnvironmentMechanismBiometry
only.Expand description
Implementations§
Source§impl LAEnvironmentMechanismBiometry
impl LAEnvironmentMechanismBiometry
Sourcepub unsafe fn biometryType(&self) -> LABiometryType
Available on crate feature LABiometryType
only.
pub unsafe fn biometryType(&self) -> LABiometryType
LABiometryType
only.Type of biometry supported by the device.
This property does not indicate whether biometry is available or not. It always reads the type of biometry
supported by device hardware. You should check
isUsable
property to see if it is available for use.
Sourcepub unsafe fn isEnrolled(&self) -> bool
pub unsafe fn isEnrolled(&self) -> bool
Whether the user has enrolled this biometry.
Even if biometry is enrolled, it does not necessarily mean that it can be used. You should check
isUsable
property to see if it is available for use.
Sourcepub unsafe fn isLockedOut(&self) -> bool
pub unsafe fn isLockedOut(&self) -> bool
Whether biometry is locked out.
The system might lock the user out of biometry for various reasons. For example, with Face ID, the user is locked out after 5 failed match attempts in row. To recover from bio lockout, users need to enter their passcode (e.g. during device ulock).
Sourcepub unsafe fn stateHash(&self) -> Retained<NSData>
pub unsafe fn stateHash(&self) -> Retained<NSData>
The application specific state of the biometric enrollment as returned by
LAContext.domainState.biometry.stateHash
This value represents the state of the enrollment and changes whenever the biometric enrollment is changed.
It does not directly map to the enrolled templates, e.g. if a finger is added to Touch ID enrollement and then
removed, the final state would be different.
It also returns different values to different apps to prevent tracking of user identity.
Sourcepub unsafe fn builtInSensorInaccessible(&self) -> bool
pub unsafe fn builtInSensorInaccessible(&self) -> bool
Whether the built in biometric sensor is inaccessible in the current configuration, preventing the use of biometry.
Currently, the only example of this is a Clamshell Mode on macOS. The user will be not able to use Touch ID if the MacBook lid is closed while connected to external monitor and keyboard, unless the external keyboard has Touch ID.
Source§impl LAEnvironmentMechanismBiometry
Methods declared on superclass LAEnvironmentMechanism
.
impl LAEnvironmentMechanismBiometry
Methods declared on superclass LAEnvironmentMechanism
.
Methods from Deref<Target = LAEnvironmentMechanism>§
Sourcepub unsafe fn isUsable(&self) -> bool
pub unsafe fn isUsable(&self) -> bool
Whether the mechanism is available for use, i.e. whether the relevant preflight call of
canEvaluatePolicy
would succeed.
Warning: If
isUsable
reads
NO,
do not assume that it’s because of some particular reason. You should check
properties of the subclass to determine why mechanism can’t be used.
Sourcepub unsafe fn localizedName(&self) -> Retained<NSString>
pub unsafe fn localizedName(&self) -> Retained<NSString>
The localized name of the authentication mechanism, e.g. “Touch ID”, “Face ID” etc.
Sourcepub unsafe fn iconSystemName(&self) -> Retained<NSString>
pub unsafe fn iconSystemName(&self) -> Retained<NSString>
Name of the SF Symbol representing this authentication mechanism.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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`
}
}
Trait Implementations§
Source§impl AsRef<LAEnvironmentMechanism> for LAEnvironmentMechanismBiometry
impl AsRef<LAEnvironmentMechanism> for LAEnvironmentMechanismBiometry
Source§fn as_ref(&self) -> &LAEnvironmentMechanism
fn as_ref(&self) -> &LAEnvironmentMechanism
Source§impl Borrow<LAEnvironmentMechanism> for LAEnvironmentMechanismBiometry
impl Borrow<LAEnvironmentMechanism> for LAEnvironmentMechanismBiometry
Source§fn borrow(&self) -> &LAEnvironmentMechanism
fn borrow(&self) -> &LAEnvironmentMechanism
Source§impl ClassType for LAEnvironmentMechanismBiometry
impl ClassType for LAEnvironmentMechanismBiometry
Source§const NAME: &'static str = "LAEnvironmentMechanismBiometry"
const NAME: &'static str = "LAEnvironmentMechanismBiometry"
Source§type Super = LAEnvironmentMechanism
type Super = LAEnvironmentMechanism
Source§type ThreadKind = <<LAEnvironmentMechanismBiometry as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<LAEnvironmentMechanismBiometry as ClassType>::Super as ClassType>::ThreadKind
Source§impl NSObjectProtocol for LAEnvironmentMechanismBiometry
impl NSObjectProtocol for LAEnvironmentMechanismBiometry
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref