Struct BlockBuilder

#[non_exhaustive]
pub struct BlockBuilder { /* private fields */ }

A builder for Block.

Implementations

impl BlockBuilder

pub fn id(self, input: impl Into<String>) -> Self

Unique identifier for the block.

pub fn set_id(self, input: Option<String>) -> Self

Unique identifier for the block.

pub fn get_id(&self) -> &Option<String>

Unique identifier for the block.

pub fn block_type(self, input: BlockType) -> Self

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 set_block_type(self, input: Option<BlockType>) -> Self

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 get_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, input: impl Into<String>) -> Self

The word or line of text extracted from the block.

pub fn set_text(self, input: Option<String>) -> Self

The word or line of text extracted from the block.

pub fn get_text(&self) -> &Option<String>

The word or line of text extracted from the block.

pub fn page(self, input: i32) -> Self

Page number where the block appears.

pub fn set_page(self, input: Option<i32>) -> Self

Page number where the block appears.

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

Page number where the block appears.

pub fn geometry(self, input: Geometry) -> Self

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

pub fn set_geometry(self, input: Option<Geometry>) -> Self

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

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

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

pub fn relationships(self, input: RelationshipsListItem) -> Self

Appends an item to relationships.

To override the contents of this collection use set_relationships.

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.

pub fn set_relationships( self, input: Option<Vec<RelationshipsListItem>>, ) -> Self

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.

pub fn get_relationships(&self) -> &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.

pub fn build(self) -> Block

Consumes the builder and constructs a Block.

Trait Implementations

impl Clone for BlockBuilder

fn clone(&self) -> BlockBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockBuilder

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

Formats the value using the given formatter.

impl Default for BlockBuilder

fn default() -> BlockBuilder

Returns the “default value” for a type.

impl PartialEq for BlockBuilder

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