Struct FormField 

#[non_exhaustive]
pub struct FormField {
    pub field_name: Option<Layout>,
    pub field_value: Option<Layout>,
    pub name_detected_languages: Vec<DetectedLanguage>,
    pub value_detected_languages: Vec<DetectedLanguage>,
    pub value_type: String,
    pub corrected_key_text: String,
    pub corrected_value_text: String,
    pub provenance: Option<Provenance>,
    /* private fields */
}

A form field detected on the page.

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.

field_name: Option<Layout>

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

field_value: Option<Layout>

Layout for the FormField value.

name_detected_languages: Vec<DetectedLanguage>

A list of detected languages for name together with confidence.

value_detected_languages: Vec<DetectedLanguage>

A list of detected languages for value together with confidence.

value_type: String

If the value is non-textual, this field represents the type. Current valid values are:

• blank (this indicates the field_value is normal text)
• unfilled_checkbox
• filled_checkbox

corrected_key_text: String

Created for Labeling UI to export key text. If corrections were made to the text identified by the field_name.text_anchor, this field will contain the correction.

corrected_value_text: String

Created for Labeling UI to export value text. If corrections were made to the text identified by the field_value.text_anchor, this field will contain the correction.

provenance: Option<Provenance>

The history of this annotation.

Implementations

impl FormField

pub fn new() -> Self

pub fn set_field_name<T>(self, v: T) -> Self

where T: Into<Layout>,

Sets the value of field_name.

Example

use google_cloud_documentai_v1::model::document::page::Layout;
let x = FormField::new().set_field_name(Layout::default()/* use setters */);

pub fn set_or_clear_field_name<T>(self, v: Option<T>) -> Self

where T: Into<Layout>,

Sets or clears the value of field_name.

Example

use google_cloud_documentai_v1::model::document::page::Layout;
let x = FormField::new().set_or_clear_field_name(Some(Layout::default()/* use setters */));
let x = FormField::new().set_or_clear_field_name(None::<Layout>);

pub fn set_field_value<T>(self, v: T) -> Self

where T: Into<Layout>,

Sets the value of field_value.

Example

use google_cloud_documentai_v1::model::document::page::Layout;
let x = FormField::new().set_field_value(Layout::default()/* use setters */);

pub fn set_or_clear_field_value<T>(self, v: Option<T>) -> Self

where T: Into<Layout>,

Sets or clears the value of field_value.

Example

use google_cloud_documentai_v1::model::document::page::Layout;
let x = FormField::new().set_or_clear_field_value(Some(Layout::default()/* use setters */));
let x = FormField::new().set_or_clear_field_value(None::<Layout>);

pub fn set_name_detected_languages<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<DetectedLanguage>,

Sets the value of name_detected_languages.

Example

use google_cloud_documentai_v1::model::document::page::DetectedLanguage;
let x = FormField::new()
    .set_name_detected_languages([
        DetectedLanguage::default()/* use setters */,
        DetectedLanguage::default()/* use (different) setters */,
    ]);

pub fn set_value_detected_languages<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<DetectedLanguage>,

Sets the value of value_detected_languages.

Example

use google_cloud_documentai_v1::model::document::page::DetectedLanguage;
let x = FormField::new()
    .set_value_detected_languages([
        DetectedLanguage::default()/* use setters */,
        DetectedLanguage::default()/* use (different) setters */,
    ]);

pub fn set_value_type<T: Into<String>>(self, v: T) -> Self

Sets the value of value_type.

Example

let x = FormField::new().set_value_type("example");

pub fn set_corrected_key_text<T: Into<String>>(self, v: T) -> Self

Sets the value of corrected_key_text.

Example

let x = FormField::new().set_corrected_key_text("example");

pub fn set_corrected_value_text<T: Into<String>>(self, v: T) -> Self

Sets the value of corrected_value_text.

Example

let x = FormField::new().set_corrected_value_text("example");

pub fn set_provenance<T>(self, v: T) -> Self

where T: Into<Provenance>,

Sets the value of provenance.

Example

use google_cloud_documentai_v1::model::document::Provenance;
let x = FormField::new().set_provenance(Provenance::default()/* use setters */);

pub fn set_or_clear_provenance<T>(self, v: Option<T>) -> Self

where T: Into<Provenance>,

Sets or clears the value of provenance.

Example

use google_cloud_documentai_v1::model::document::Provenance;
let x = FormField::new().set_or_clear_provenance(Some(Provenance::default()/* use setters */));
let x = FormField::new().set_or_clear_provenance(None::<Provenance>);

Trait Implementations

impl Clone for FormField

fn clone(&self) -> FormField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormField

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

Formats the value using the given formatter.

impl Default for FormField

fn default() -> FormField

Returns the “default value” for a type.

impl Message for FormField

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FormField

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