#[non_exhaustive]pub enum StartSpeechSynthesisTaskError {
Show 13 variants
EngineNotSupportedException(EngineNotSupportedException),
InvalidS3BucketException(InvalidS3BucketException),
InvalidS3KeyException(InvalidS3KeyException),
InvalidSampleRateException(InvalidSampleRateException),
InvalidSnsTopicArnException(InvalidSnsTopicArnException),
InvalidSsmlException(InvalidSsmlException),
LanguageNotSupportedException(LanguageNotSupportedException),
LexiconNotFoundException(LexiconNotFoundException),
MarksNotSupportedForFormatException(MarksNotSupportedForFormatException),
ServiceFailureException(ServiceFailureException),
SsmlMarksNotSupportedForTextTypeException(SsmlMarksNotSupportedForTextTypeException),
TextLengthExceededException(TextLengthExceededException),
Unhandled(Unhandled),
}
Expand description
Error type for the StartSpeechSynthesisTaskError
operation.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
EngineNotSupportedException(EngineNotSupportedException)
This engine is not compatible with the voice that you have designated. Choose a new voice that is compatible with the engine or change the engine and restart the operation.
InvalidS3BucketException(InvalidS3BucketException)
The provided Amazon S3 bucket name is invalid. Please check your input with S3 bucket naming requirements and try again.
InvalidS3KeyException(InvalidS3KeyException)
The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object key name.
InvalidSampleRateException(InvalidSampleRateException)
The specified sample rate is not valid.
InvalidSnsTopicArnException(InvalidSnsTopicArnException)
The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN and try again.
InvalidSsmlException(InvalidSsmlException)
The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try again.
LanguageNotSupportedException(LanguageNotSupportedException)
The language specified is not currently supported by Amazon Polly in this capacity.
LexiconNotFoundException(LexiconNotFoundException)
Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.
Verify that the lexicon exists, is in the region (see ListLexicons
) and that you spelled its name is spelled correctly. Then try again.
MarksNotSupportedForFormatException(MarksNotSupportedForFormatException)
Speech marks are not supported for the OutputFormat
selected. Speech marks are only available for content in json
format.
ServiceFailureException(ServiceFailureException)
An unknown condition has caused a service failure.
SsmlMarksNotSupportedForTextTypeException(SsmlMarksNotSupportedForTextTypeException)
SSML speech marks are not supported for plain text-type input.
TextLengthExceededException(TextLengthExceededException)
The value of the "Text" parameter is longer than the accepted limits. For the SynthesizeSpeech
API, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask
API, the maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not counted as billed characters.
Unhandled(Unhandled)
Unhandled
directly is not forwards compatible. Instead, match using a variable wildcard pattern and check .code()
:
err if err.code() == Some("SpecificExceptionCode") => { /* handle the error */ }
See ProvideErrorMetadata
for what information is available for the error.An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
Implementations§
Source§impl StartSpeechSynthesisTaskError
impl StartSpeechSynthesisTaskError
Sourcepub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self
pub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self
Creates the StartSpeechSynthesisTaskError::Unhandled
variant from any error type.
Sourcepub fn generic(err: ErrorMetadata) -> Self
pub fn generic(err: ErrorMetadata) -> Self
Creates the StartSpeechSynthesisTaskError::Unhandled
variant from an ErrorMetadata
.
Sourcepub fn meta(&self) -> &ErrorMetadata
pub fn meta(&self) -> &ErrorMetadata
Returns error metadata, which includes the error code, message, request ID, and potentially additional information.
Sourcepub fn is_engine_not_supported_exception(&self) -> bool
pub fn is_engine_not_supported_exception(&self) -> bool
Returns true
if the error kind is StartSpeechSynthesisTaskError::EngineNotSupportedException
.
Sourcepub fn is_invalid_s3_bucket_exception(&self) -> bool
pub fn is_invalid_s3_bucket_exception(&self) -> bool
Returns true
if the error kind is StartSpeechSynthesisTaskError::InvalidS3BucketException
.
Sourcepub fn is_invalid_s3_key_exception(&self) -> bool
pub fn is_invalid_s3_key_exception(&self) -> bool
Returns true
if the error kind is StartSpeechSynthesisTaskError::InvalidS3KeyException
.
Sourcepub fn is_invalid_sample_rate_exception(&self) -> bool
pub fn is_invalid_sample_rate_exception(&self) -> bool
Returns true
if the error kind is StartSpeechSynthesisTaskError::InvalidSampleRateException
.
Sourcepub fn is_invalid_sns_topic_arn_exception(&self) -> bool
pub fn is_invalid_sns_topic_arn_exception(&self) -> bool
Returns true
if the error kind is StartSpeechSynthesisTaskError::InvalidSnsTopicArnException
.
Sourcepub fn is_invalid_ssml_exception(&self) -> bool
pub fn is_invalid_ssml_exception(&self) -> bool
Returns true
if the error kind is StartSpeechSynthesisTaskError::InvalidSsmlException
.
Sourcepub fn is_language_not_supported_exception(&self) -> bool
pub fn is_language_not_supported_exception(&self) -> bool
Returns true
if the error kind is StartSpeechSynthesisTaskError::LanguageNotSupportedException
.
Sourcepub fn is_lexicon_not_found_exception(&self) -> bool
pub fn is_lexicon_not_found_exception(&self) -> bool
Returns true
if the error kind is StartSpeechSynthesisTaskError::LexiconNotFoundException
.
Sourcepub fn is_marks_not_supported_for_format_exception(&self) -> bool
pub fn is_marks_not_supported_for_format_exception(&self) -> bool
Returns true
if the error kind is StartSpeechSynthesisTaskError::MarksNotSupportedForFormatException
.
Sourcepub fn is_service_failure_exception(&self) -> bool
pub fn is_service_failure_exception(&self) -> bool
Returns true
if the error kind is StartSpeechSynthesisTaskError::ServiceFailureException
.
Sourcepub fn is_ssml_marks_not_supported_for_text_type_exception(&self) -> bool
pub fn is_ssml_marks_not_supported_for_text_type_exception(&self) -> bool
Returns true
if the error kind is StartSpeechSynthesisTaskError::SsmlMarksNotSupportedForTextTypeException
.
Sourcepub fn is_text_length_exceeded_exception(&self) -> bool
pub fn is_text_length_exceeded_exception(&self) -> bool
Returns true
if the error kind is StartSpeechSynthesisTaskError::TextLengthExceededException
.
Trait Implementations§
Source§impl CreateUnhandledError for StartSpeechSynthesisTaskError
impl CreateUnhandledError for StartSpeechSynthesisTaskError
Source§fn create_unhandled_error(
source: Box<dyn Error + Send + Sync + 'static>,
meta: Option<ErrorMetadata>,
) -> Self
fn create_unhandled_error( source: Box<dyn Error + Send + Sync + 'static>, meta: Option<ErrorMetadata>, ) -> Self
source
and error metadata.Source§impl Error for StartSpeechSynthesisTaskError
impl Error for StartSpeechSynthesisTaskError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
Source§impl From<StartSpeechSynthesisTaskError> for Error
impl From<StartSpeechSynthesisTaskError> for Error
Source§fn from(err: StartSpeechSynthesisTaskError) -> Self
fn from(err: StartSpeechSynthesisTaskError) -> Self
Source§impl ProvideErrorMetadata for StartSpeechSynthesisTaskError
impl ProvideErrorMetadata for StartSpeechSynthesisTaskError
Source§fn meta(&self) -> &ErrorMetadata
fn meta(&self) -> &ErrorMetadata
Source§impl RequestId for StartSpeechSynthesisTaskError
impl RequestId for StartSpeechSynthesisTaskError
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.Auto Trait Implementations§
impl Freeze for StartSpeechSynthesisTaskError
impl !RefUnwindSafe for StartSpeechSynthesisTaskError
impl Send for StartSpeechSynthesisTaskError
impl Sync for StartSpeechSynthesisTaskError
impl Unpin for StartSpeechSynthesisTaskError
impl !UnwindSafe for StartSpeechSynthesisTaskError
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> 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);