Struct IdentityDocument

#[non_exhaustive]
pub struct IdentityDocument {
    pub document_index: Option<i32>,
    pub identity_document_fields: Option<Vec<IdentityDocumentField>>,
    pub blocks: Option<Vec<Block>>,
}

The structure that lists each document processed in an AnalyzeID operation.

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.

document_index: Option<i32>

Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

identity_document_fields: Option<Vec<IdentityDocumentField>>

The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

blocks: Option<Vec<Block>>

Individual word recognition, as returned by document detection.

Implementations

impl IdentityDocument

pub fn document_index(&self) -> Option<i32>

Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

pub fn identity_document_fields(&self) -> &[IdentityDocumentField]

The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

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

pub fn blocks(&self) -> &[Block]

Individual word recognition, as returned by document detection.

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

impl IdentityDocument

pub fn builder() -> IdentityDocumentBuilder

Creates a new builder-style object to manufacture IdentityDocument.

Trait Implementations

impl Clone for IdentityDocument

fn clone(&self) -> IdentityDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityDocument

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

Formats the value using the given formatter.

impl PartialEq for IdentityDocument

fn eq(&self, other: &IdentityDocument) -> 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 StructuralPartialEq for IdentityDocument