Struct ComparedFace

#[non_exhaustive]
pub struct ComparedFace {
    pub bounding_box: Option<BoundingBox>,
    pub confidence: Option<f32>,
    pub landmarks: Option<Vec<Landmark>>,
    pub pose: Option<Pose>,
    pub quality: Option<ImageQuality>,
    pub emotions: Option<Vec<Emotion>>,
    pub smile: Option<Smile>,
}

Provides face metadata for target image faces that are analyzed by CompareFaces and RecognizeCelebrities.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bounding_box: Option<BoundingBox>

Bounding box of the face.

confidence: Option<f32>

Level of confidence that what the bounding box contains is a face.

landmarks: Option<Vec<Landmark>>

An array of facial landmarks.

pose: Option<Pose>

Indicates the pose of the face as determined by its pitch, roll, and yaw.

quality: Option<ImageQuality>

Identifies face image brightness and sharpness.

emotions: Option<Vec<Emotion>>

The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

smile: Option<Smile>

Indicates whether or not the face is smiling, and the confidence level in the determination.

Implementations

impl ComparedFace

pub fn bounding_box(&self) -> Option<&BoundingBox>

Bounding box of the face.

pub fn confidence(&self) -> Option<f32>

Level of confidence that what the bounding box contains is a face.

pub fn landmarks(&self) -> &[Landmark]

An array of facial landmarks.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .landmarks.is_none().

pub fn pose(&self) -> Option<&Pose>

Indicates the pose of the face as determined by its pitch, roll, and yaw.

pub fn quality(&self) -> Option<&ImageQuality>

Identifies face image brightness and sharpness.

pub fn emotions(&self) -> &[Emotion]

The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .emotions.is_none().

pub fn smile(&self) -> Option<&Smile>

Indicates whether or not the face is smiling, and the confidence level in the determination.

impl ComparedFace

pub fn builder() -> ComparedFaceBuilder

Creates a new builder-style object to manufacture ComparedFace.

Trait Implementations

impl Clone for ComparedFace

fn clone(&self) -> ComparedFace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComparedFace

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

Formats the value using the given formatter.

impl PartialEq for ComparedFace

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

Tests for self and other values to be equal, and is used by ==.

const 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 StructuralPartialEq for ComparedFace