Struct aws_sdk_rekognition::types::TextDetection

#[non_exhaustive]
pub struct TextDetection {
    pub detected_text: Option<String>,
    pub type: Option<TextTypes>,
    pub id: Option<i32>,
    pub parent_id: Option<i32>,
    pub confidence: Option<f32>,
    pub geometry: Option<Geometry>,
}

Information about a word or line of text detected by DetectText.

The DetectedText field contains the text that Amazon Rekognition detected in the image.

Every word and line has an identifier (Id). Each word belongs to a line and has a parent identifier (ParentId) that identifies the line of text in which the word appears. The word Id is also an index for the word within a line of words.

For more information, see Detecting text in the Amazon Rekognition Developer Guide.

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.

detected_text: Option<String>

The word or line of text recognized by Amazon Rekognition.

type: Option<TextTypes>

The type of text that was detected.

id: Option<i32>

The identifier for the detected text. The identifier is only unique for a single call to DetectText.

parent_id: Option<i32>

The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.

confidence: Option<f32>

The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.

geometry: Option<Geometry>

The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.

Implementations

impl TextDetection

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

The word or line of text recognized by Amazon Rekognition.

pub fn type(&self) -> Option<&TextTypes>

The type of text that was detected.

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

The identifier for the detected text. The identifier is only unique for a single call to DetectText.

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

The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.

pub fn confidence(&self) -> Option<f32>

The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.

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

The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.

impl TextDetection

pub fn builder() -> TextDetectionBuilder

Creates a new builder-style object to manufacture TextDetection.

Trait Implementations

impl Clone for TextDetection

fn clone(&self) -> TextDetection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextDetection

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

Formats the value using the given formatter.

impl PartialEq<TextDetection> for TextDetection

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TextDetection