aws_sdk_rekognition/operation/detect_text/
_detect_text_output.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct DetectTextOutput {
6    /// <p>An array of text that was detected in the input image.</p>
7    pub text_detections: ::std::option::Option<::std::vec::Vec<crate::types::TextDetection>>,
8    /// <p>The model version used to detect text.</p>
9    pub text_model_version: ::std::option::Option<::std::string::String>,
10    _request_id: Option<String>,
11}
12impl DetectTextOutput {
13    /// <p>An array of text that was detected in the input image.</p>
14    ///
15    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.text_detections.is_none()`.
16    pub fn text_detections(&self) -> &[crate::types::TextDetection] {
17        self.text_detections.as_deref().unwrap_or_default()
18    }
19    /// <p>The model version used to detect text.</p>
20    pub fn text_model_version(&self) -> ::std::option::Option<&str> {
21        self.text_model_version.as_deref()
22    }
23}
24impl ::aws_types::request_id::RequestId for DetectTextOutput {
25    fn request_id(&self) -> Option<&str> {
26        self._request_id.as_deref()
27    }
28}
29impl DetectTextOutput {
30    /// Creates a new builder-style object to manufacture [`DetectTextOutput`](crate::operation::detect_text::DetectTextOutput).
31    pub fn builder() -> crate::operation::detect_text::builders::DetectTextOutputBuilder {
32        crate::operation::detect_text::builders::DetectTextOutputBuilder::default()
33    }
34}
35
36/// A builder for [`DetectTextOutput`](crate::operation::detect_text::DetectTextOutput).
37#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
38#[non_exhaustive]
39pub struct DetectTextOutputBuilder {
40    pub(crate) text_detections: ::std::option::Option<::std::vec::Vec<crate::types::TextDetection>>,
41    pub(crate) text_model_version: ::std::option::Option<::std::string::String>,
42    _request_id: Option<String>,
43}
44impl DetectTextOutputBuilder {
45    /// Appends an item to `text_detections`.
46    ///
47    /// To override the contents of this collection use [`set_text_detections`](Self::set_text_detections).
48    ///
49    /// <p>An array of text that was detected in the input image.</p>
50    pub fn text_detections(mut self, input: crate::types::TextDetection) -> Self {
51        let mut v = self.text_detections.unwrap_or_default();
52        v.push(input);
53        self.text_detections = ::std::option::Option::Some(v);
54        self
55    }
56    /// <p>An array of text that was detected in the input image.</p>
57    pub fn set_text_detections(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TextDetection>>) -> Self {
58        self.text_detections = input;
59        self
60    }
61    /// <p>An array of text that was detected in the input image.</p>
62    pub fn get_text_detections(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TextDetection>> {
63        &self.text_detections
64    }
65    /// <p>The model version used to detect text.</p>
66    pub fn text_model_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
67        self.text_model_version = ::std::option::Option::Some(input.into());
68        self
69    }
70    /// <p>The model version used to detect text.</p>
71    pub fn set_text_model_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
72        self.text_model_version = input;
73        self
74    }
75    /// <p>The model version used to detect text.</p>
76    pub fn get_text_model_version(&self) -> &::std::option::Option<::std::string::String> {
77        &self.text_model_version
78    }
79    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
80        self._request_id = Some(request_id.into());
81        self
82    }
83
84    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
85        self._request_id = request_id;
86        self
87    }
88    /// Consumes the builder and constructs a [`DetectTextOutput`](crate::operation::detect_text::DetectTextOutput).
89    pub fn build(self) -> crate::operation::detect_text::DetectTextOutput {
90        crate::operation::detect_text::DetectTextOutput {
91            text_detections: self.text_detections,
92            text_model_version: self.text_model_version,
93            _request_id: self._request_id,
94        }
95    }
96}