#[non_exhaustive]pub struct GetDocumentAnalysisOutput {
pub document_metadata: Option<DocumentMetadata>,
pub job_status: Option<JobStatus>,
pub next_token: Option<String>,
pub blocks: Option<Vec<Block>>,
pub warnings: Option<Vec<Warning>>,
pub status_message: Option<String>,
pub analyze_document_model_version: Option<String>,
/* private fields */
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.document_metadata: Option<DocumentMetadata>
Information about a document that Amazon Textract processed. DocumentMetadata
is returned in every page of paginated responses from an Amazon Textract video operation.
job_status: Option<JobStatus>
The current status of the text detection job.
next_token: Option<String>
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.
blocks: Option<Vec<Block>>
The results of the text-analysis operation.
warnings: Option<Vec<Warning>>
A list of warnings that occurred during the document-analysis operation.
status_message: Option<String>
Returns if the detection job could not be completed. Contains explanation for what error occured.
analyze_document_model_version: Option<String>
Implementations§
Source§impl GetDocumentAnalysisOutput
impl GetDocumentAnalysisOutput
Sourcepub fn document_metadata(&self) -> Option<&DocumentMetadata>
pub fn document_metadata(&self) -> Option<&DocumentMetadata>
Information about a document that Amazon Textract processed. DocumentMetadata
is returned in every page of paginated responses from an Amazon Textract video operation.
Sourcepub fn job_status(&self) -> Option<&JobStatus>
pub fn job_status(&self) -> Option<&JobStatus>
The current status of the text detection job.
Sourcepub fn next_token(&self) -> Option<&str>
pub fn next_token(&self) -> Option<&str>
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.
Sourcepub fn blocks(&self) -> &[Block]
pub fn blocks(&self) -> &[Block]
The results of the text-analysis operation.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .blocks.is_none()
.
Sourcepub fn warnings(&self) -> &[Warning]
pub fn warnings(&self) -> &[Warning]
A list of warnings that occurred during the document-analysis operation.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .warnings.is_none()
.
Sourcepub fn status_message(&self) -> Option<&str>
pub fn status_message(&self) -> Option<&str>
Returns if the detection job could not be completed. Contains explanation for what error occured.
Sourcepub fn analyze_document_model_version(&self) -> Option<&str>
pub fn analyze_document_model_version(&self) -> Option<&str>
Source§impl GetDocumentAnalysisOutput
impl GetDocumentAnalysisOutput
Sourcepub fn builder() -> GetDocumentAnalysisOutputBuilder
pub fn builder() -> GetDocumentAnalysisOutputBuilder
Creates a new builder-style object to manufacture GetDocumentAnalysisOutput
.
Trait Implementations§
Source§impl Clone for GetDocumentAnalysisOutput
impl Clone for GetDocumentAnalysisOutput
Source§fn clone(&self) -> GetDocumentAnalysisOutput
fn clone(&self) -> GetDocumentAnalysisOutput
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GetDocumentAnalysisOutput
impl Debug for GetDocumentAnalysisOutput
Source§impl PartialEq for GetDocumentAnalysisOutput
impl PartialEq for GetDocumentAnalysisOutput
Source§fn eq(&self, other: &GetDocumentAnalysisOutput) -> bool
fn eq(&self, other: &GetDocumentAnalysisOutput) -> bool
self
and other
values to be equal, and is used by ==
.Source§impl RequestId for GetDocumentAnalysisOutput
impl RequestId for GetDocumentAnalysisOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for GetDocumentAnalysisOutput
Auto Trait Implementations§
impl Freeze for GetDocumentAnalysisOutput
impl RefUnwindSafe for GetDocumentAnalysisOutput
impl Send for GetDocumentAnalysisOutput
impl Sync for GetDocumentAnalysisOutput
impl Unpin for GetDocumentAnalysisOutput
impl UnwindSafe for GetDocumentAnalysisOutput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);