Struct BoundingBox

#[non_exhaustive]
pub struct BoundingBox {
    pub width: f32,
    pub height: f32,
    pub left: f32,
    pub top: f32,
}

The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

The top and left values returned are ratios of the overall document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

The width and height values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

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.

width: f32

The width of the bounding box as a ratio of the overall document page width.

height: f32

The height of the bounding box as a ratio of the overall document page height.

left: f32

The left coordinate of the bounding box as a ratio of overall document page width.

top: f32

The top coordinate of the bounding box as a ratio of overall document page height.

Implementations

impl BoundingBox

pub fn width(&self) -> f32

The width of the bounding box as a ratio of the overall document page width.

pub fn height(&self) -> f32

The height of the bounding box as a ratio of the overall document page height.

pub fn left(&self) -> f32

The left coordinate of the bounding box as a ratio of overall document page width.

pub fn top(&self) -> f32

The top coordinate of the bounding box as a ratio of overall document page height.

impl BoundingBox

pub fn builder() -> BoundingBoxBuilder

Creates a new builder-style object to manufacture BoundingBox.

Trait Implementations

impl Clone for BoundingBox

fn clone(&self) -> BoundingBox

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BoundingBox

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

Formats the value using the given formatter.

impl PartialEq for BoundingBox

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