Skip to main content

LAPolicy

Enum LAPolicy 

Source
#[non_exhaustive]
pub enum LAPolicy { DeviceOwnerAuthenticationWithBiometrics, DeviceOwnerAuthentication, DeviceOwnerAuthenticationWithCompanion, DeviceOwnerAuthenticationWithBiometricsOrCompanion, DeviceOwnerAuthenticationWithWatch, DeviceOwnerAuthenticationWithBiometricsOrWatch, }
Expand description

Authentication policies supported on macOS by LocalAuthentication.framework.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

DeviceOwnerAuthenticationWithBiometrics

Authenticate the device owner using biometry only.

§

DeviceOwnerAuthentication

Authenticate the device owner using biometry or the local password.

§

DeviceOwnerAuthenticationWithCompanion

Authenticate the device owner using a nearby companion device.

§

DeviceOwnerAuthenticationWithBiometricsOrCompanion

Authenticate the device owner using biometry or a nearby companion device.

§

DeviceOwnerAuthenticationWithWatch

👎Deprecated:

Use DeviceOwnerAuthenticationWithCompanion instead.

Deprecated alias for companion-device authentication.

§

DeviceOwnerAuthenticationWithBiometricsOrWatch

👎Deprecated:

Use DeviceOwnerAuthenticationWithBiometricsOrCompanion instead.

Deprecated alias for biometry-or-companion authentication.

Implementations§

Source§

impl LAPolicy

Source

pub const fn raw_value(self) -> i32

Source

pub const fn description(self) -> &'static str

A short, human-readable name for the policy.

Examples found in repository?
examples/02_policy_catalog.rs (line 15)
3fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let context = LAContext::new()?;
5    let policies = [
6        LAPolicy::DeviceOwnerAuthenticationWithBiometrics,
7        LAPolicy::DeviceOwnerAuthentication,
8        LAPolicy::DeviceOwnerAuthenticationWithCompanion,
9        LAPolicy::DeviceOwnerAuthenticationWithBiometricsOrCompanion,
10    ];
11
12    for policy in policies {
13        println!(
14            "{} => {:?}",
15            policy.description(),
16            context.can_evaluate_policy(policy)
17        );
18    }
19
20    println!("✅ policy catalogue OK");
21    Ok(())
22}

Trait Implementations§

Source§

impl Clone for LAPolicy

Source§

fn clone(&self) -> LAPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for LAPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for LAPolicy

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for LAPolicy

Source§

fn eq(&self, other: &LAPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for LAPolicy

Source§

impl Eq for LAPolicy

Source§

impl StructuralPartialEq for LAPolicy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.