Struct Block 

#[non_exhaustive]
pub struct Block {
    pub property: Option<TextProperty>,
    pub bounding_box: Option<BoundingPoly>,
    pub paragraphs: Vec<Paragraph>,
    pub block_type: BlockType,
    pub confidence: f32,
    /* private fields */
}

Logical element on the page.

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.

property: Option<TextProperty>

Additional information detected for the block.

bounding_box: Option<BoundingPoly>

The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the ‘natural’ orientation. For example:

• when the text is horizontal it might look like:

• when it’s rotated 180 degrees around the top-left corner it becomes:

  and the vertex order will still be (0, 1, 2, 3).

  0----1
  |    |
  3----2

  2----3
  |    |
  1----0

paragraphs: Vec<Paragraph>

List of paragraphs in this block (if this blocks is of type text).

block_type: BlockType

Detected block type (text, image etc) for this block.

confidence: f32

Confidence of the OCR results on the block. Range [0, 1].

Implementations

impl Block

pub fn new() -> Self

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

where T: Into<TextProperty>,

Sets the value of property.

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

where T: Into<TextProperty>,

Sets or clears the value of property.

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

where T: Into<BoundingPoly>,

Sets the value of bounding_box.

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.

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

where T: IntoIterator<Item = V>, V: Into<Paragraph>,

Sets the value of paragraphs.

pub fn set_block_type<T: Into<BlockType>>(self, v: T) -> Self

Sets the value of block_type.

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

Sets the value of confidence.

Trait Implementations

impl Clone for Block

fn clone(&self) -> Block

Returns a duplicate of the value.

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 Default for Block

fn default() -> Block

Returns the “default value” for a type.

impl Message for Block

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Block

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