Struct Block

#[non_exhaustive]
pub struct Block {
    pub id: Option<String>,
    pub block_type: Option<BlockType>,
    pub text: Option<String>,
    pub page: Option<i32>,
    pub geometry: Option<Geometry>,
    pub relationships: Option<Vec<RelationshipsListItem>>,
}

Information about each word or line of text in the input document.

For additional information, see Block in the Amazon Textract API reference.

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.

id: Option<String>

Unique identifier for the block.

block_type: Option<BlockType>

The block represents a line of text or one word of text.

• WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.

• LINE - A string of tab-delimited, contiguous words that are detected on a document page

text: Option<String>

The word or line of text extracted from the block.

page: Option<i32>

Page number where the block appears.

geometry: Option<Geometry>

Co-ordinates of the rectangle or polygon that contains the text.

relationships: Option<Vec<RelationshipsListItem>>

A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text.

Implementations

impl Block

pub fn id(&self) -> Option<&str>

Unique identifier for the block.

pub fn block_type(&self) -> Option<&BlockType>

The block represents a line of text or one word of text.

• WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.

• LINE - A string of tab-delimited, contiguous words that are detected on a document page

pub fn text(&self) -> Option<&str>

The word or line of text extracted from the block.

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

Page number where the block appears.

pub fn geometry(&self) -> Option<&Geometry>

Co-ordinates of the rectangle or polygon that contains the text.

pub fn relationships(&self) -> &[RelationshipsListItem]

A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text.

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

impl Block

pub fn builder() -> BlockBuilder

Creates a new builder-style object to manufacture Block.

Trait Implementations

impl Clone for Block

fn clone(&self) -> Block

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Block

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

Formats the value using the given formatter.

impl PartialEq for Block

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