#[non_exhaustive]pub struct SubtitlesOutput {
pub formats: Option<Vec<SubtitleFormat>>,
pub subtitle_file_uris: Option<Vec<String>>,
pub output_start_index: Option<i32>,
}
Expand description
Provides information about your subtitle file, including format, start index, and Amazon S3 location.
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.formats: Option<Vec<SubtitleFormat>>
Provides the format of your subtitle files. If your request included both WebVTT (vtt
) and SubRip (srt
) formats, both formats are shown.
subtitle_file_uris: Option<Vec<String>>
The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided.
If you included OutputBucketName
in your transcription job request, this is the URI of that bucket. If you also included OutputKey
in your request, your output is located in the path you specified in your request.
If you didn't include OutputBucketName
in your transcription job request, your subtitle file is stored in a service-managed bucket, and TranscriptFileUri
provides you with a temporary URI you can use for secure access to your subtitle file.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied
error, you can get a new temporary URI by running a GetTranscriptionJob
or ListTranscriptionJob
request.
output_start_index: Option<i32>
Provides the start index value for your subtitle files. If you did not specify a value in your request, the default value of 0
is used.
Implementations§
Source§impl SubtitlesOutput
impl SubtitlesOutput
Sourcepub fn formats(&self) -> &[SubtitleFormat]
pub fn formats(&self) -> &[SubtitleFormat]
Provides the format of your subtitle files. If your request included both WebVTT (vtt
) and SubRip (srt
) formats, both formats are shown.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .formats.is_none()
.
Sourcepub fn subtitle_file_uris(&self) -> &[String]
pub fn subtitle_file_uris(&self) -> &[String]
The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided.
If you included OutputBucketName
in your transcription job request, this is the URI of that bucket. If you also included OutputKey
in your request, your output is located in the path you specified in your request.
If you didn't include OutputBucketName
in your transcription job request, your subtitle file is stored in a service-managed bucket, and TranscriptFileUri
provides you with a temporary URI you can use for secure access to your subtitle file.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied
error, you can get a new temporary URI by running a GetTranscriptionJob
or ListTranscriptionJob
request.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .subtitle_file_uris.is_none()
.
Sourcepub fn output_start_index(&self) -> Option<i32>
pub fn output_start_index(&self) -> Option<i32>
Provides the start index value for your subtitle files. If you did not specify a value in your request, the default value of 0
is used.
Source§impl SubtitlesOutput
impl SubtitlesOutput
Sourcepub fn builder() -> SubtitlesOutputBuilder
pub fn builder() -> SubtitlesOutputBuilder
Creates a new builder-style object to manufacture SubtitlesOutput
.
Trait Implementations§
Source§impl Clone for SubtitlesOutput
impl Clone for SubtitlesOutput
Source§fn clone(&self) -> SubtitlesOutput
fn clone(&self) -> SubtitlesOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SubtitlesOutput
impl Debug for SubtitlesOutput
Source§impl PartialEq for SubtitlesOutput
impl PartialEq for SubtitlesOutput
impl StructuralPartialEq for SubtitlesOutput
Auto Trait Implementations§
impl Freeze for SubtitlesOutput
impl RefUnwindSafe for SubtitlesOutput
impl Send for SubtitlesOutput
impl Sync for SubtitlesOutput
impl Unpin for SubtitlesOutput
impl UnwindSafe for SubtitlesOutput
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);