#[non_exhaustive]pub struct TranslateDocumentOutput {
pub translated_document: Option<TranslatedDocument>,
pub source_language_code: String,
pub target_language_code: String,
pub applied_terminologies: Option<Vec<AppliedTerminology>>,
pub applied_settings: Option<TranslationSettings>,
/* 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.translated_document: Option<TranslatedDocument>
The document containing the translated content. The document format matches the source document format.
source_language_code: String
The language code of the source document.
target_language_code: String
The language code of the translated document.
applied_terminologies: Option<Vec<AppliedTerminology>>
The names of the custom terminologies applied to the input text by Amazon Translate to produce the translated text document.
applied_settings: Option<TranslationSettings>
Settings to configure your translation output. You can configure the following options:
-
Brevity: reduces the length of the translation output for most translations. Available for
TranslateText
only. -
Formality: sets the formality level of the translation output.
-
Profanity: masks profane words and phrases in the translation output.
Implementations§
Source§impl TranslateDocumentOutput
impl TranslateDocumentOutput
Sourcepub fn translated_document(&self) -> Option<&TranslatedDocument>
pub fn translated_document(&self) -> Option<&TranslatedDocument>
The document containing the translated content. The document format matches the source document format.
Sourcepub fn source_language_code(&self) -> &str
pub fn source_language_code(&self) -> &str
The language code of the source document.
Sourcepub fn target_language_code(&self) -> &str
pub fn target_language_code(&self) -> &str
The language code of the translated document.
Sourcepub fn applied_terminologies(&self) -> &[AppliedTerminology]
pub fn applied_terminologies(&self) -> &[AppliedTerminology]
The names of the custom terminologies applied to the input text by Amazon Translate to produce the translated text document.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .applied_terminologies.is_none()
.
Sourcepub fn applied_settings(&self) -> Option<&TranslationSettings>
pub fn applied_settings(&self) -> Option<&TranslationSettings>
Settings to configure your translation output. You can configure the following options:
-
Brevity: reduces the length of the translation output for most translations. Available for
TranslateText
only. -
Formality: sets the formality level of the translation output.
-
Profanity: masks profane words and phrases in the translation output.
Source§impl TranslateDocumentOutput
impl TranslateDocumentOutput
Sourcepub fn builder() -> TranslateDocumentOutputBuilder
pub fn builder() -> TranslateDocumentOutputBuilder
Creates a new builder-style object to manufacture TranslateDocumentOutput
.
Trait Implementations§
Source§impl Clone for TranslateDocumentOutput
impl Clone for TranslateDocumentOutput
Source§fn clone(&self) -> TranslateDocumentOutput
fn clone(&self) -> TranslateDocumentOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TranslateDocumentOutput
impl Debug for TranslateDocumentOutput
Source§impl PartialEq for TranslateDocumentOutput
impl PartialEq for TranslateDocumentOutput
Source§impl RequestId for TranslateDocumentOutput
impl RequestId for TranslateDocumentOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for TranslateDocumentOutput
Auto Trait Implementations§
impl Freeze for TranslateDocumentOutput
impl RefUnwindSafe for TranslateDocumentOutput
impl Send for TranslateDocumentOutput
impl Sync for TranslateDocumentOutput
impl Unpin for TranslateDocumentOutput
impl UnwindSafe for TranslateDocumentOutput
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);