Struct LAEnvironmentMechanismBiometry 

pub struct LAEnvironmentMechanismBiometry { /* private fields */ }

Biometric LAEnvironment mechanism details.

Implementations

impl LAEnvironmentMechanismBiometry

pub fn is_usable(&self) -> Result<bool>

Whether the mechanism is currently usable for authentication.

Errors

Returns an error if the Swift bridge rejects the request.

Examples found in repository

examples/10_environment.rs (line 43)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let environment = match LAEnvironment::current_user() {
        Ok(environment) => environment,
        Err(error) => {
            println!("environment APIs require macOS 15+: {error}");
            return Ok(());
        }
    };

    let notifications = Arc::new(AtomicUsize::new(0));
    let registration = environment.add_observer({
        let notifications = Arc::clone(&notifications);
        move |environment: &LAEnvironment, old_state: &LAEnvironmentState| {
            let current_count = environment
                .state()
                .and_then(|state| state.all_mechanisms().map(|items| items.len()))
                .unwrap_or_default();
            let previous_count = old_state
                .all_mechanisms()
                .map(|items| items.len())
                .unwrap_or_default();
            println!(
                "environment changed: {previous_count} -> {current_count} mechanisms"
            );
            notifications.fetch_add(1, Ordering::Relaxed);
        }
    })?;

    let state = environment.state()?;
    println!("all mechanisms: {}", state.all_mechanisms()?.len());

    if let Some(biometry) = state.biometry()? {
        println!(
            "biometry: {:?}, enrolled={}, usable={}, icon={}",
            biometry.biometry_type()?,
            biometry.is_enrolled()?,
            biometry.is_usable()?,
            biometry.icon_system_name()?
        );
    }

    if let Some(user_password) = state.user_password()? {
        println!(
            "user password: set={}, usable={}, label={}",
            user_password.is_set()?,
            user_password.is_usable()?,
            user_password.localized_name()?
        );
    }

    for companion in state.companions()? {
        println!(
            "companion {:?}: usable={}, state-hash-bytes={}",
            companion.companion_type()?,
            companion.is_usable()?,
            companion.state_hash()?.map_or(0, |hash| hash.len())
        );
    }

    environment.remove_observer(&registration)?;
    println!(
        "observer notifications seen so far: {}",
        notifications.load(Ordering::Relaxed)
    );
    println!("✅ environment smoke OK");
    Ok(())
}

pub fn localized_name(&self) -> Result<String>

Localized display name such as Touch ID or Face ID.

Errors

Returns an error if the Swift bridge rejects the request.

pub fn icon_system_name(&self) -> Result<String>

SF Symbol name representing this mechanism.

Errors

Returns an error if the Swift bridge rejects the request.

Examples found in repository

examples/10_environment.rs (line 44)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let environment = match LAEnvironment::current_user() {
        Ok(environment) => environment,
        Err(error) => {
            println!("environment APIs require macOS 15+: {error}");
            return Ok(());
        }
    };

    let notifications = Arc::new(AtomicUsize::new(0));
    let registration = environment.add_observer({
        let notifications = Arc::clone(&notifications);
        move |environment: &LAEnvironment, old_state: &LAEnvironmentState| {
            let current_count = environment
                .state()
                .and_then(|state| state.all_mechanisms().map(|items| items.len()))
                .unwrap_or_default();
            let previous_count = old_state
                .all_mechanisms()
                .map(|items| items.len())
                .unwrap_or_default();
            println!(
                "environment changed: {previous_count} -> {current_count} mechanisms"
            );
            notifications.fetch_add(1, Ordering::Relaxed);
        }
    })?;

    let state = environment.state()?;
    println!("all mechanisms: {}", state.all_mechanisms()?.len());

    if let Some(biometry) = state.biometry()? {
        println!(
            "biometry: {:?}, enrolled={}, usable={}, icon={}",
            biometry.biometry_type()?,
            biometry.is_enrolled()?,
            biometry.is_usable()?,
            biometry.icon_system_name()?
        );
    }

    if let Some(user_password) = state.user_password()? {
        println!(
            "user password: set={}, usable={}, label={}",
            user_password.is_set()?,
            user_password.is_usable()?,
            user_password.localized_name()?
        );
    }

    for companion in state.companions()? {
        println!(
            "companion {:?}: usable={}, state-hash-bytes={}",
            companion.companion_type()?,
            companion.is_usable()?,
            companion.state_hash()?.map_or(0, |hash| hash.len())
        );
    }

    environment.remove_observer(&registration)?;
    println!(
        "observer notifications seen so far: {}",
        notifications.load(Ordering::Relaxed)
    );
    println!("✅ environment smoke OK");
    Ok(())
}

pub fn biometry_type(&self) -> Result<BiometryType>

Hardware biometry type supported by the device.

Errors

Returns an error if the Swift bridge rejects the request.

Examples found in repository

examples/10_environment.rs (line 41)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let environment = match LAEnvironment::current_user() {
        Ok(environment) => environment,
        Err(error) => {
            println!("environment APIs require macOS 15+: {error}");
            return Ok(());
        }
    };

    let notifications = Arc::new(AtomicUsize::new(0));
    let registration = environment.add_observer({
        let notifications = Arc::clone(&notifications);
        move |environment: &LAEnvironment, old_state: &LAEnvironmentState| {
            let current_count = environment
                .state()
                .and_then(|state| state.all_mechanisms().map(|items| items.len()))
                .unwrap_or_default();
            let previous_count = old_state
                .all_mechanisms()
                .map(|items| items.len())
                .unwrap_or_default();
            println!(
                "environment changed: {previous_count} -> {current_count} mechanisms"
            );
            notifications.fetch_add(1, Ordering::Relaxed);
        }
    })?;

    let state = environment.state()?;
    println!("all mechanisms: {}", state.all_mechanisms()?.len());

    if let Some(biometry) = state.biometry()? {
        println!(
            "biometry: {:?}, enrolled={}, usable={}, icon={}",
            biometry.biometry_type()?,
            biometry.is_enrolled()?,
            biometry.is_usable()?,
            biometry.icon_system_name()?
        );
    }

    if let Some(user_password) = state.user_password()? {
        println!(
            "user password: set={}, usable={}, label={}",
            user_password.is_set()?,
            user_password.is_usable()?,
            user_password.localized_name()?
        );
    }

    for companion in state.companions()? {
        println!(
            "companion {:?}: usable={}, state-hash-bytes={}",
            companion.companion_type()?,
            companion.is_usable()?,
            companion.state_hash()?.map_or(0, |hash| hash.len())
        );
    }

    environment.remove_observer(&registration)?;
    println!(
        "observer notifications seen so far: {}",
        notifications.load(Ordering::Relaxed)
    );
    println!("✅ environment smoke OK");
    Ok(())
}

pub fn is_enrolled(&self) -> Result<bool>

Whether the user has enrolled this biometric mechanism.

Errors

Returns an error if the Swift bridge rejects the request.

Examples found in repository

examples/10_environment.rs (line 42)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let environment = match LAEnvironment::current_user() {
        Ok(environment) => environment,
        Err(error) => {
            println!("environment APIs require macOS 15+: {error}");
            return Ok(());
        }
    };

    let notifications = Arc::new(AtomicUsize::new(0));
    let registration = environment.add_observer({
        let notifications = Arc::clone(&notifications);
        move |environment: &LAEnvironment, old_state: &LAEnvironmentState| {
            let current_count = environment
                .state()
                .and_then(|state| state.all_mechanisms().map(|items| items.len()))
                .unwrap_or_default();
            let previous_count = old_state
                .all_mechanisms()
                .map(|items| items.len())
                .unwrap_or_default();
            println!(
                "environment changed: {previous_count} -> {current_count} mechanisms"
            );
            notifications.fetch_add(1, Ordering::Relaxed);
        }
    })?;

    let state = environment.state()?;
    println!("all mechanisms: {}", state.all_mechanisms()?.len());

    if let Some(biometry) = state.biometry()? {
        println!(
            "biometry: {:?}, enrolled={}, usable={}, icon={}",
            biometry.biometry_type()?,
            biometry.is_enrolled()?,
            biometry.is_usable()?,
            biometry.icon_system_name()?
        );
    }

    if let Some(user_password) = state.user_password()? {
        println!(
            "user password: set={}, usable={}, label={}",
            user_password.is_set()?,
            user_password.is_usable()?,
            user_password.localized_name()?
        );
    }

    for companion in state.companions()? {
        println!(
            "companion {:?}: usable={}, state-hash-bytes={}",
            companion.companion_type()?,
            companion.is_usable()?,
            companion.state_hash()?.map_or(0, |hash| hash.len())
        );
    }

    environment.remove_observer(&registration)?;
    println!(
        "observer notifications seen so far: {}",
        notifications.load(Ordering::Relaxed)
    );
    println!("✅ environment smoke OK");
    Ok(())
}

pub fn is_locked_out(&self) -> Result<bool>

Whether the biometric mechanism is locked out.

Errors

Returns an error if the Swift bridge rejects the request.

pub fn state_hash(&self) -> Result<Vec<u8>>

Application-specific biometric enrollment hash.

Errors

Returns an error if the Swift bridge rejects the request.

pub fn built_in_sensor_inaccessible(&self) -> Result<bool>

Whether the built-in biometric sensor is inaccessible.

Errors

Returns an error if the Swift bridge rejects the request.

Trait Implementations

impl Debug for LAEnvironmentMechanismBiometry

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

Formats the value using the given formatter.