Struct DocumentLayoutBlock 

#[non_exhaustive]
pub struct DocumentLayoutBlock {
    pub block_id: String,
    pub page_span: Option<LayoutPageSpan>,
    pub bounding_box: Option<BoundingPoly>,
    pub block: Option<Block>,
    /* private fields */
}

Represents a block. A block could be one of the various types (text, table, list) 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.

block_id: String

ID of the block.

page_span: Option<LayoutPageSpan>

Page span of the block.

bounding_box: Option<BoundingPoly>

Identifies the bounding box for the block.

block: Option<Block>

Implementations

impl DocumentLayoutBlock

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of block_id.

Example

let x = DocumentLayoutBlock::new().set_block_id("example");

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

where T: Into<LayoutPageSpan>,

Sets the value of page_span.

Example

use google_cloud_documentai_v1::model::document::document_layout::document_layout_block::LayoutPageSpan;
let x = DocumentLayoutBlock::new().set_page_span(LayoutPageSpan::default()/* use setters */);

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

where T: Into<LayoutPageSpan>,

Sets or clears the value of page_span.

Example

use google_cloud_documentai_v1::model::document::document_layout::document_layout_block::LayoutPageSpan;
let x = DocumentLayoutBlock::new().set_or_clear_page_span(Some(LayoutPageSpan::default()/* use setters */));
let x = DocumentLayoutBlock::new().set_or_clear_page_span(None::<LayoutPageSpan>);

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

where T: Into<BoundingPoly>,

Sets the value of bounding_box.

Example

use google_cloud_documentai_v1::model::BoundingPoly;
let x = DocumentLayoutBlock::new().set_bounding_box(BoundingPoly::default()/* use setters */);

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

where T: Into<BoundingPoly>,

Sets or clears the value of bounding_box.

Example

use google_cloud_documentai_v1::model::BoundingPoly;
let x = DocumentLayoutBlock::new().set_or_clear_bounding_box(Some(BoundingPoly::default()/* use setters */));
let x = DocumentLayoutBlock::new().set_or_clear_bounding_box(None::<BoundingPoly>);

pub fn set_block<T: Into<Option<Block>>>(self, v: T) -> Self

Sets the value of block.

Note that all the setters affecting block are mutually exclusive.

Example

use google_cloud_documentai_v1::model::document::document_layout::document_layout_block::LayoutTextBlock;
let x = DocumentLayoutBlock::new().set_block(Some(
    google_cloud_documentai_v1::model::document::document_layout::document_layout_block::Block::TextBlock(LayoutTextBlock::default().into())));

pub fn text_block(&self) -> Option<&Box<LayoutTextBlock>>

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

pub fn set_text_block<T: Into<Box<LayoutTextBlock>>>(self, v: T) -> Self

Sets the value of block to hold a TextBlock.

Note that all the setters affecting block are mutually exclusive.

Example

use google_cloud_documentai_v1::model::document::document_layout::document_layout_block::LayoutTextBlock;
let x = DocumentLayoutBlock::new().set_text_block(LayoutTextBlock::default()/* use setters */);
assert!(x.text_block().is_some());
assert!(x.table_block().is_none());
assert!(x.list_block().is_none());
assert!(x.image_block().is_none());

pub fn table_block(&self) -> Option<&Box<LayoutTableBlock>>

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

pub fn set_table_block<T: Into<Box<LayoutTableBlock>>>(self, v: T) -> Self

Sets the value of block to hold a TableBlock.

Note that all the setters affecting block are mutually exclusive.

Example

use google_cloud_documentai_v1::model::document::document_layout::document_layout_block::LayoutTableBlock;
let x = DocumentLayoutBlock::new().set_table_block(LayoutTableBlock::default()/* use setters */);
assert!(x.table_block().is_some());
assert!(x.text_block().is_none());
assert!(x.list_block().is_none());
assert!(x.image_block().is_none());

pub fn list_block(&self) -> Option<&Box<LayoutListBlock>>

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

pub fn set_list_block<T: Into<Box<LayoutListBlock>>>(self, v: T) -> Self

Sets the value of block to hold a ListBlock.

Note that all the setters affecting block are mutually exclusive.

Example

use google_cloud_documentai_v1::model::document::document_layout::document_layout_block::LayoutListBlock;
let x = DocumentLayoutBlock::new().set_list_block(LayoutListBlock::default()/* use setters */);
assert!(x.list_block().is_some());
assert!(x.text_block().is_none());
assert!(x.table_block().is_none());
assert!(x.image_block().is_none());

pub fn image_block(&self) -> Option<&Box<LayoutImageBlock>>

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

pub fn set_image_block<T: Into<Box<LayoutImageBlock>>>(self, v: T) -> Self

Sets the value of block to hold a ImageBlock.

Note that all the setters affecting block are mutually exclusive.

Example

use google_cloud_documentai_v1::model::document::document_layout::document_layout_block::LayoutImageBlock;
let x = DocumentLayoutBlock::new().set_image_block(LayoutImageBlock::default()/* use setters */);
assert!(x.image_block().is_some());
assert!(x.text_block().is_none());
assert!(x.table_block().is_none());
assert!(x.list_block().is_none());

Trait Implementations

impl Clone for DocumentLayoutBlock

fn clone(&self) -> DocumentLayoutBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentLayoutBlock

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

Formats the value using the given formatter.

impl Default for DocumentLayoutBlock

fn default() -> DocumentLayoutBlock

Returns the “default value” for a type.

impl Message for DocumentLayoutBlock

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DocumentLayoutBlock

fn eq(&self, other: &DocumentLayoutBlock) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DocumentLayoutBlock