aws_sdk_mediaconvert/types/_prores_framerate_control.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// When writing a match expression against `ProresFramerateControl`, it is important to ensure
4/// your code is forward-compatible. That is, if a match arm handles a case for a
5/// feature that is supported by the service but has not been represented as an enum
6/// variant in a current version of SDK, your code should continue to work when you
7/// upgrade SDK to a future version in which the enum does include a variant for that
8/// feature.
9///
10/// Here is an example of how you can make a match expression forward-compatible:
11///
12/// ```text
13/// # let proresframeratecontrol = unimplemented!();
14/// match proresframeratecontrol {
15/// ProresFramerateControl::InitializeFromSource => { /* ... */ },
16/// ProresFramerateControl::Specified => { /* ... */ },
17/// other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
18/// _ => { /* ... */ },
19/// }
20/// ```
21/// The above code demonstrates that when `proresframeratecontrol` represents
22/// `NewFeature`, the execution path will lead to the second last match arm,
23/// even though the enum does not contain a variant `ProresFramerateControl::NewFeature`
24/// in the current version of SDK. The reason is that the variable `other`,
25/// created by the `@` operator, is bound to
26/// `ProresFramerateControl::Unknown(UnknownVariantValue("NewFeature".to_owned()))`
27/// and calling `as_str` on it yields `"NewFeature"`.
28/// This match expression is forward-compatible when executed with a newer
29/// version of SDK where the variant `ProresFramerateControl::NewFeature` is defined.
30/// Specifically, when `proresframeratecontrol` represents `NewFeature`,
31/// the execution path will hit the second last match arm as before by virtue of
32/// calling `as_str` on `ProresFramerateControl::NewFeature` also yielding `"NewFeature"`.
33///
34/// Explicitly matching on the `Unknown` variant should
35/// be avoided for two reasons:
36/// - The inner data `UnknownVariantValue` is opaque, and no further information can be extracted.
37/// - It might inadvertently shadow other intended match arms.
38///
39/// If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction.
40#[non_exhaustive]
41#[derive(
42 ::std::clone::Clone, ::std::cmp::Eq, ::std::cmp::Ord, ::std::cmp::PartialEq, ::std::cmp::PartialOrd, ::std::fmt::Debug, ::std::hash::Hash,
43)]
44pub enum ProresFramerateControl {
45 #[allow(missing_docs)] // documentation missing in model
46 InitializeFromSource,
47 #[allow(missing_docs)] // documentation missing in model
48 Specified,
49 /// `Unknown` contains new variants that have been added since this code was generated.
50 #[deprecated(note = "Don't directly match on `Unknown`. See the docs on this enum for the correct way to handle unknown variants.")]
51 Unknown(crate::primitives::sealed_enum_unknown::UnknownVariantValue),
52}
53impl ::std::convert::From<&str> for ProresFramerateControl {
54 fn from(s: &str) -> Self {
55 match s {
56 "INITIALIZE_FROM_SOURCE" => ProresFramerateControl::InitializeFromSource,
57 "SPECIFIED" => ProresFramerateControl::Specified,
58 other => ProresFramerateControl::Unknown(crate::primitives::sealed_enum_unknown::UnknownVariantValue(other.to_owned())),
59 }
60 }
61}
62impl ::std::str::FromStr for ProresFramerateControl {
63 type Err = ::std::convert::Infallible;
64
65 fn from_str(s: &str) -> ::std::result::Result<Self, <Self as ::std::str::FromStr>::Err> {
66 ::std::result::Result::Ok(ProresFramerateControl::from(s))
67 }
68}
69impl ProresFramerateControl {
70 /// Returns the `&str` value of the enum member.
71 pub fn as_str(&self) -> &str {
72 match self {
73 ProresFramerateControl::InitializeFromSource => "INITIALIZE_FROM_SOURCE",
74 ProresFramerateControl::Specified => "SPECIFIED",
75 ProresFramerateControl::Unknown(value) => value.as_str(),
76 }
77 }
78 /// Returns all the `&str` representations of the enum members.
79 pub const fn values() -> &'static [&'static str] {
80 &["INITIALIZE_FROM_SOURCE", "SPECIFIED"]
81 }
82}
83impl ::std::convert::AsRef<str> for ProresFramerateControl {
84 fn as_ref(&self) -> &str {
85 self.as_str()
86 }
87}
88impl ProresFramerateControl {
89 /// Parses the enum value while disallowing unknown variants.
90 ///
91 /// Unknown variants will result in an error.
92 pub fn try_parse(value: &str) -> ::std::result::Result<Self, crate::error::UnknownVariantError> {
93 match Self::from(value) {
94 #[allow(deprecated)]
95 Self::Unknown(_) => ::std::result::Result::Err(crate::error::UnknownVariantError::new(value)),
96 known => Ok(known),
97 }
98 }
99}
100impl ::std::fmt::Display for ProresFramerateControl {
101 fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
102 match self {
103 ProresFramerateControl::InitializeFromSource => write!(f, "INITIALIZE_FROM_SOURCE"),
104 ProresFramerateControl::Specified => write!(f, "SPECIFIED"),
105 ProresFramerateControl::Unknown(value) => write!(f, "{value}"),
106 }
107 }
108}