Struct NormalizedValue 

#[non_exhaustive]
pub struct NormalizedValue {
    pub text: String,
    pub structured_value: Option<StructuredValue>,
    /* private fields */
}

Parsed and normalized entity value.

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.

text: String

Optional. An optional field to store a normalized string. For some entity types, one of respective structured_value fields may also be populated. Also not all the types of structured_value will be normalized. For example, some processors may not generate float or integer normalized text by default.

Below are sample formats mapped to structured values.

• Money/Currency type (money_value) is in the ISO 4217 text format.
• Date type (date_value) is in the ISO 8601 text format.
• Datetime type (datetime_value) is in the ISO 8601 text format.

structured_value: Option<StructuredValue>

An optional structured entity value. Must match entity type defined in schema if known. If this field is present, the text field could also be populated.

Implementations

impl NormalizedValue

pub fn new() -> Self

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

Sets the value of text.

Example

let x = NormalizedValue::new().set_text("example");

pub fn set_structured_value<T: Into<Option<StructuredValue>>>( self, v: T, ) -> Self

Sets the value of structured_value.

Note that all the setters affecting structured_value are mutually exclusive.

Example

use google_cloud_documentai_v1::model::document::entity::normalized_value::StructuredValue;
let x = NormalizedValue::new().set_structured_value(Some(StructuredValue::BooleanValue(true)));

pub fn money_value(&self) -> Option<&Box<Money>>

The value of structured_value if it holds a MoneyValue, None if the field is not set or holds a different branch.

pub fn set_money_value<T: Into<Box<Money>>>(self, v: T) -> Self

Sets the value of structured_value to hold a MoneyValue.

Note that all the setters affecting structured_value are mutually exclusive.

Example

use gtype::model::Money;
let x = NormalizedValue::new().set_money_value(Money::default()/* use setters */);
assert!(x.money_value().is_some());
assert!(x.date_value().is_none());
assert!(x.datetime_value().is_none());
assert!(x.address_value().is_none());
assert!(x.boolean_value().is_none());
assert!(x.integer_value().is_none());
assert!(x.float_value().is_none());
assert!(x.signature_value().is_none());

pub fn date_value(&self) -> Option<&Box<Date>>

The value of structured_value if it holds a DateValue, None if the field is not set or holds a different branch.

pub fn set_date_value<T: Into<Box<Date>>>(self, v: T) -> Self

Sets the value of structured_value to hold a DateValue.

Note that all the setters affecting structured_value are mutually exclusive.

Example

use gtype::model::Date;
let x = NormalizedValue::new().set_date_value(Date::default()/* use setters */);
assert!(x.date_value().is_some());
assert!(x.money_value().is_none());
assert!(x.datetime_value().is_none());
assert!(x.address_value().is_none());
assert!(x.boolean_value().is_none());
assert!(x.integer_value().is_none());
assert!(x.float_value().is_none());
assert!(x.signature_value().is_none());

pub fn datetime_value(&self) -> Option<&Box<DateTime>>

The value of structured_value if it holds a DatetimeValue, None if the field is not set or holds a different branch.

pub fn set_datetime_value<T: Into<Box<DateTime>>>(self, v: T) -> Self

Sets the value of structured_value to hold a DatetimeValue.

Note that all the setters affecting structured_value are mutually exclusive.

Example

use gtype::model::DateTime;
let x = NormalizedValue::new().set_datetime_value(DateTime::default()/* use setters */);
assert!(x.datetime_value().is_some());
assert!(x.money_value().is_none());
assert!(x.date_value().is_none());
assert!(x.address_value().is_none());
assert!(x.boolean_value().is_none());
assert!(x.integer_value().is_none());
assert!(x.float_value().is_none());
assert!(x.signature_value().is_none());

pub fn address_value(&self) -> Option<&Box<PostalAddress>>

The value of structured_value if it holds a AddressValue, None if the field is not set or holds a different branch.

pub fn set_address_value<T: Into<Box<PostalAddress>>>(self, v: T) -> Self

Sets the value of structured_value to hold a AddressValue.

Note that all the setters affecting structured_value are mutually exclusive.

Example

use gtype::model::PostalAddress;
let x = NormalizedValue::new().set_address_value(PostalAddress::default()/* use setters */);
assert!(x.address_value().is_some());
assert!(x.money_value().is_none());
assert!(x.date_value().is_none());
assert!(x.datetime_value().is_none());
assert!(x.boolean_value().is_none());
assert!(x.integer_value().is_none());
assert!(x.float_value().is_none());
assert!(x.signature_value().is_none());

pub fn boolean_value(&self) -> Option<&bool>

The value of structured_value if it holds a BooleanValue, None if the field is not set or holds a different branch.

pub fn set_boolean_value<T: Into<bool>>(self, v: T) -> Self

Sets the value of structured_value to hold a BooleanValue.

Note that all the setters affecting structured_value are mutually exclusive.

Example

let x = NormalizedValue::new().set_boolean_value(true);
assert!(x.boolean_value().is_some());
assert!(x.money_value().is_none());
assert!(x.date_value().is_none());
assert!(x.datetime_value().is_none());
assert!(x.address_value().is_none());
assert!(x.integer_value().is_none());
assert!(x.float_value().is_none());
assert!(x.signature_value().is_none());

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

The value of structured_value if it holds a IntegerValue, None if the field is not set or holds a different branch.

pub fn set_integer_value<T: Into<i32>>(self, v: T) -> Self

Sets the value of structured_value to hold a IntegerValue.

Note that all the setters affecting structured_value are mutually exclusive.

Example

let x = NormalizedValue::new().set_integer_value(42);
assert!(x.integer_value().is_some());
assert!(x.money_value().is_none());
assert!(x.date_value().is_none());
assert!(x.datetime_value().is_none());
assert!(x.address_value().is_none());
assert!(x.boolean_value().is_none());
assert!(x.float_value().is_none());
assert!(x.signature_value().is_none());

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

The value of structured_value if it holds a FloatValue, None if the field is not set or holds a different branch.

pub fn set_float_value<T: Into<f32>>(self, v: T) -> Self

Sets the value of structured_value to hold a FloatValue.

Note that all the setters affecting structured_value are mutually exclusive.

Example

let x = NormalizedValue::new().set_float_value(42.0);
assert!(x.float_value().is_some());
assert!(x.money_value().is_none());
assert!(x.date_value().is_none());
assert!(x.datetime_value().is_none());
assert!(x.address_value().is_none());
assert!(x.boolean_value().is_none());
assert!(x.integer_value().is_none());
assert!(x.signature_value().is_none());

pub fn signature_value(&self) -> Option<&bool>

The value of structured_value if it holds a SignatureValue, None if the field is not set or holds a different branch.

pub fn set_signature_value<T: Into<bool>>(self, v: T) -> Self

Sets the value of structured_value to hold a SignatureValue.

Note that all the setters affecting structured_value are mutually exclusive.

Example

let x = NormalizedValue::new().set_signature_value(true);
assert!(x.signature_value().is_some());
assert!(x.money_value().is_none());
assert!(x.date_value().is_none());
assert!(x.datetime_value().is_none());
assert!(x.address_value().is_none());
assert!(x.boolean_value().is_none());
assert!(x.integer_value().is_none());
assert!(x.float_value().is_none());

Trait Implementations

impl Clone for NormalizedValue

fn clone(&self) -> NormalizedValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NormalizedValue

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

Formats the value using the given formatter.

impl Default for NormalizedValue

fn default() -> NormalizedValue

Returns the “default value” for a type.

impl Message for NormalizedValue

fn typename() -> &'static str

The typename of this message.

impl PartialEq for NormalizedValue

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