Struct FpPrint

pub struct FpPrint { /* private fields */ }

Struct representing a fingerprint.

Implementations

impl FpPrint

pub fn new(dev: &FpDevice) -> Self

Create a new FpPrint. This is only useful to prepare an enrollment of a new print using FpDevice::enroll_sync. For this you should first create a new print, fill in the relevant metadata, and then start the enrollment

Examples found in repository

examples/verify.rs (line 11)

fn main() {
    // Get devices
    let ctx = FpContext::new();
    let devices = ctx.devices();
    let dev = devices.get(0).unwrap();
    dev.open_sync(None).unwrap();

    // Create a template print
    let template = FpPrint::new(&dev);
    let enrolled_print = dev
        .enroll_sync(template, None, Some(progress_cb), None)
        .unwrap();

    // New print where we will store the next print
    let mut new_print = FpPrint::new(&dev);

    // Verify if the next print matches the previously enrolled print
    let matched = dev
        .verify_sync(
            &enrolled_print,
            None,
            Some(match_cb),
            None,
            Some(&mut new_print),
        )
        .unwrap();
    if matched {
        println!("Matched again");
    }
}

examples/enroll.rs (line 18)

fn main() {
    // Get context
    let ctx = FpContext::new();
    // Collect connected devices
    let devices = ctx.devices();

    // Get the first connected device
    let dev = devices.get(0).unwrap();

    // Open the device to start operations
    dev.open_sync(None).unwrap();

    // Create a template print
    let template = FpPrint::new(&dev);
    template.set_finger(FpFinger::RightRing);
    template.set_username("test");

    // User data that we will use on the callback function,
    // to mutate the value of a counter, it must be wrapped in an Arc<Mutex<T>>
    let counter = Arc::new(Mutex::new(0));

    // Get the new print from the user
    let _new_print = dev
        .enroll_sync(template, None, Some(progress_cb), Some(counter.clone()))
        .unwrap();

    // Get the total of time the enroll callback was called
    println!("Total enroll stages: {}", counter.lock().unwrap());
}

pub fn driver(&self) -> String

Returns the driver that the print was created for.

pub fn device_id(&self) -> String

Returns the device ID that the print was created for.

pub fn device_stored(&self) -> bool

Whether the print is actually stored on the device and this is just a handle to use that references the device stored data.

pub fn image(&self) -> Option<FpImage>

Returns the image that the print was created from, or None

pub fn finger(&self) -> FpFinger

Returns the finger that the print was created for.

pub fn username(&self) -> Option<String>

Returns the user defined username for the print.

pub fn description(&self) -> Option<String>

Returns the user defined description for the print.

pub fn enroll_date(&self) -> Option<GDate>

Returns the user defined enroll date for the print.

pub fn set_finger(&self, finger: FpFinger)

Set the finger that the print is for.

Examples found in repository

examples/enroll.rs (line 19)

fn main() {
    // Get context
    let ctx = FpContext::new();
    // Collect connected devices
    let devices = ctx.devices();

    // Get the first connected device
    let dev = devices.get(0).unwrap();

    // Open the device to start operations
    dev.open_sync(None).unwrap();

    // Create a template print
    let template = FpPrint::new(&dev);
    template.set_finger(FpFinger::RightRing);
    template.set_username("test");

    // User data that we will use on the callback function,
    // to mutate the value of a counter, it must be wrapped in an Arc<Mutex<T>>
    let counter = Arc::new(Mutex::new(0));

    // Get the new print from the user
    let _new_print = dev
        .enroll_sync(template, None, Some(progress_cb), Some(counter.clone()))
        .unwrap();

    // Get the total of time the enroll callback was called
    println!("Total enroll stages: {}", counter.lock().unwrap());
}

pub fn set_username(&self, username: &str)

Set the username for the print.

Examples found in repository

examples/enroll.rs (line 20)

fn main() {
    // Get context
    let ctx = FpContext::new();
    // Collect connected devices
    let devices = ctx.devices();

    // Get the first connected device
    let dev = devices.get(0).unwrap();

    // Open the device to start operations
    dev.open_sync(None).unwrap();

    // Create a template print
    let template = FpPrint::new(&dev);
    template.set_finger(FpFinger::RightRing);
    template.set_username("test");

    // User data that we will use on the callback function,
    // to mutate the value of a counter, it must be wrapped in an Arc<Mutex<T>>
    let counter = Arc::new(Mutex::new(0));

    // Get the new print from the user
    let _new_print = dev
        .enroll_sync(template, None, Some(progress_cb), Some(counter.clone()))
        .unwrap();

    // Get the total of time the enroll callback was called
    println!("Total enroll stages: {}", counter.lock().unwrap());
}

pub fn set_description(&self, description: &str)

Set the description for the print.

pub fn set_enroll_date(&self, enroll_date: GDate)

Set the enroll date for the print.

pub fn compatible(&self, device: &FpDevice) -> bool

Tests whether the prints is compatible with the given device.

pub fn equal(&self, other: &FpPrint) -> bool

Tests whether the prints can be considered equal. This only compares the actual information about the print, not the metadata.

pub fn serialize(&self) -> Result<Vec<u8>, Error>

Serialize a print definition for permanent storage. Note that this is lossy in the sense that e.g. the image data is discarded.

pub fn deserialize(data: &[u8]) -> Result<FpPrint, Error>

Deserialize a print definition from permanent storage.

Trait Implementations

impl Clone for FpPrint

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FpPrint

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

Formats the value using the given formatter.

impl HasParamSpec for FpPrint

type ParamSpec = ParamSpecObject

type SetValue = FpPrint

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, FpPrint>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FpPrint

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

where H: Hasher,

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 Ord for FpPrint

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for FpPrint

type Parent = InitiallyUnowned

impl<OT: ObjectType> PartialEq<OT> for FpPrint

fn eq(&self, other: &OT) -> 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<OT: ObjectType> PartialOrd<OT> for FpPrint

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FpPrint

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FpPrint

impl IsA<InitiallyUnowned> for FpPrint