Struct ExpenseField

#[non_exhaustive]
pub struct ExpenseField {
    pub type: Option<ExpenseType>,
    pub label_detection: Option<ExpenseDetection>,
    pub value_detection: Option<ExpenseDetection>,
    pub page_number: Option<i32>,
    pub currency: Option<ExpenseCurrency>,
    pub group_properties: Option<Vec<ExpenseGroupProperty>>,
}

Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection

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.

type: Option<ExpenseType>

The implied label of a detected element. Present alongside LabelDetection for explicit elements.

label_detection: Option<ExpenseDetection>

The explicitly stated label of a detected element.

value_detection: Option<ExpenseDetection>

The value of a detected element. Present in explicit and implicit elements.

page_number: Option<i32>

The page number the value was detected on.

currency: Option<ExpenseCurrency>

Shows the kind of currency, both the code and confidence associated with any monatary value detected.

group_properties: Option<Vec<ExpenseGroupProperty>>

Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.

Implementations

impl ExpenseField

pub fn type(&self) -> Option<&ExpenseType>

The implied label of a detected element. Present alongside LabelDetection for explicit elements.

pub fn label_detection(&self) -> Option<&ExpenseDetection>

The explicitly stated label of a detected element.

pub fn value_detection(&self) -> Option<&ExpenseDetection>

The value of a detected element. Present in explicit and implicit elements.

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

The page number the value was detected on.

pub fn currency(&self) -> Option<&ExpenseCurrency>

Shows the kind of currency, both the code and confidence associated with any monatary value detected.

pub fn group_properties(&self) -> &[ExpenseGroupProperty]

Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.

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

impl ExpenseField

pub fn builder() -> ExpenseFieldBuilder

Creates a new builder-style object to manufacture ExpenseField.

Trait Implementations

impl Clone for ExpenseField

fn clone(&self) -> ExpenseField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExpenseField

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

Formats the value using the given formatter.

impl PartialEq for ExpenseField

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