#[non_exhaustive]pub enum SccDestinationFramerate {
Framerate2397,
Framerate24,
Framerate25,
Framerate2997Dropframe,
Framerate2997NonDropframe,
Unknown(UnknownVariantValue),
}
Expand description
When writing a match expression against SccDestinationFramerate
, it is important to ensure
your code is forward-compatible. That is, if a match arm handles a case for a
feature that is supported by the service but has not been represented as an enum
variant in a current version of SDK, your code should continue to work when you
upgrade SDK to a future version in which the enum does include a variant for that
feature.
Here is an example of how you can make a match expression forward-compatible:
# let sccdestinationframerate = unimplemented!();
match sccdestinationframerate {
SccDestinationFramerate::Framerate2397 => { /* ... */ },
SccDestinationFramerate::Framerate24 => { /* ... */ },
SccDestinationFramerate::Framerate25 => { /* ... */ },
SccDestinationFramerate::Framerate2997Dropframe => { /* ... */ },
SccDestinationFramerate::Framerate2997NonDropframe => { /* ... */ },
other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
_ => { /* ... */ },
}
The above code demonstrates that when sccdestinationframerate
represents
NewFeature
, the execution path will lead to the second last match arm,
even though the enum does not contain a variant SccDestinationFramerate::NewFeature
in the current version of SDK. The reason is that the variable other
,
created by the @
operator, is bound to
SccDestinationFramerate::Unknown(UnknownVariantValue("NewFeature".to_owned()))
and calling as_str
on it yields "NewFeature"
.
This match expression is forward-compatible when executed with a newer
version of SDK where the variant SccDestinationFramerate::NewFeature
is defined.
Specifically, when sccdestinationframerate
represents NewFeature
,
the execution path will hit the second last match arm as before by virtue of
calling as_str
on SccDestinationFramerate::NewFeature
also yielding "NewFeature"
.
Explicitly matching on the Unknown
variant should
be avoided for two reasons:
- The inner data
UnknownVariantValue
is opaque, and no further information can be extracted. - It might inadvertently shadow other intended match arms. Set Framerate to make sure that the captions and the video are synchronized in the output. Specify a frame rate that matches the frame rate of the associated video. If the video frame rate is 29.97, choose 29.97 dropframe only if the video has video_insertion=true and drop_frame_timecode=true; otherwise, choose 29.97 non-dropframe.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Framerate2397
Framerate24
Framerate25
Framerate2997Dropframe
Framerate2997NonDropframe
Unknown(UnknownVariantValue)
Unknown
. See the docs on this enum for the correct way to handle unknown variants.Unknown
contains new variants that have been added since this code was generated.
Implementations§
source§impl SccDestinationFramerate
impl SccDestinationFramerate
sourcepub fn try_parse(value: &str) -> Result<Self, UnknownVariantError>
pub fn try_parse(value: &str) -> Result<Self, UnknownVariantError>
Parses the enum value while disallowing unknown variants.
Unknown variants will result in an error.
Trait Implementations§
source§impl AsRef<str> for SccDestinationFramerate
impl AsRef<str> for SccDestinationFramerate
source§impl Clone for SccDestinationFramerate
impl Clone for SccDestinationFramerate
source§fn clone(&self) -> SccDestinationFramerate
fn clone(&self) -> SccDestinationFramerate
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for SccDestinationFramerate
impl Debug for SccDestinationFramerate
source§impl Display for SccDestinationFramerate
impl Display for SccDestinationFramerate
source§impl From<&str> for SccDestinationFramerate
impl From<&str> for SccDestinationFramerate
source§impl FromStr for SccDestinationFramerate
impl FromStr for SccDestinationFramerate
source§impl Hash for SccDestinationFramerate
impl Hash for SccDestinationFramerate
source§impl Ord for SccDestinationFramerate
impl Ord for SccDestinationFramerate
source§fn cmp(&self, other: &SccDestinationFramerate) -> Ordering
fn cmp(&self, other: &SccDestinationFramerate) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for SccDestinationFramerate
impl PartialEq for SccDestinationFramerate
source§fn eq(&self, other: &SccDestinationFramerate) -> bool
fn eq(&self, other: &SccDestinationFramerate) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for SccDestinationFramerate
impl PartialOrd for SccDestinationFramerate
source§fn partial_cmp(&self, other: &SccDestinationFramerate) -> Option<Ordering>
fn partial_cmp(&self, other: &SccDestinationFramerate) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moreimpl Eq for SccDestinationFramerate
impl StructuralPartialEq for SccDestinationFramerate
Auto Trait Implementations§
impl Freeze for SccDestinationFramerate
impl RefUnwindSafe for SccDestinationFramerate
impl Send for SccDestinationFramerate
impl Sync for SccDestinationFramerate
impl Unpin for SccDestinationFramerate
impl UnwindSafe for SccDestinationFramerate
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<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.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 more