Struct ChunkField 

#[non_exhaustive]
pub struct ChunkField {
    pub field_type: Option<FieldType>,
    /* private fields */
}

The chunk field in the chunk. A chunk field could be one of the various types (for example, image, table) supported.

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_type: Option<FieldType>

The type of the chunk field.

Implementations

impl ChunkField

pub fn new() -> Self

Creates a new default instance.

pub fn set_field_type<T: Into<Option<FieldType>>>(self, v: T) -> Self

Sets the value of field_type.

Note that all the setters affecting field_type are mutually exclusive.

Example

use google_cloud_documentai_v1::model::document::chunked_document::chunk::ImageChunkField;
let x = ChunkField::new().set_field_type(Some(
    google_cloud_documentai_v1::model::document::chunked_document::chunk::chunk_field::FieldType::ImageChunkField(ImageChunkField::default().into())));

pub fn image_chunk_field(&self) -> Option<&Box<ImageChunkField>>

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

pub fn set_image_chunk_field<T: Into<Box<ImageChunkField>>>(self, v: T) -> Self

Sets the value of field_type to hold a ImageChunkField.

Note that all the setters affecting field_type are mutually exclusive.

Example

use google_cloud_documentai_v1::model::document::chunked_document::chunk::ImageChunkField;
let x = ChunkField::new().set_image_chunk_field(ImageChunkField::default()/* use setters */);
assert!(x.image_chunk_field().is_some());
assert!(x.table_chunk_field().is_none());

pub fn table_chunk_field(&self) -> Option<&Box<TableChunkField>>

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

pub fn set_table_chunk_field<T: Into<Box<TableChunkField>>>(self, v: T) -> Self

Sets the value of field_type to hold a TableChunkField.

Note that all the setters affecting field_type are mutually exclusive.

Example

use google_cloud_documentai_v1::model::document::chunked_document::chunk::TableChunkField;
let x = ChunkField::new().set_table_chunk_field(TableChunkField::default()/* use setters */);
assert!(x.table_chunk_field().is_some());
assert!(x.image_chunk_field().is_none());

Trait Implementations

impl Clone for ChunkField

fn clone(&self) -> ChunkField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChunkField

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

Formats the value using the given formatter.

impl Default for ChunkField

fn default() -> ChunkField

Returns the “default value” for a type.

impl Message for ChunkField

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ChunkField

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