// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// When writing a match expression against `State`, 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:
///
/// ```text
/// # let state = unimplemented!();
/// match state {
/// State::Offline => { /* ... */ },
/// State::Online => { /* ... */ },
/// State::Starting => { /* ... */ },
/// State::StartFailed => { /* ... */ },
/// State::Stopping => { /* ... */ },
/// State::StopFailed => { /* ... */ },
/// other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
/// _ => { /* ... */ },
/// }
/// ```
/// The above code demonstrates that when `state` represents
/// `NewFeature`, the execution path will lead to the second last match arm,
/// even though the enum does not contain a variant `State::NewFeature`
/// in the current version of SDK. The reason is that the variable `other`,
/// created by the `@` operator, is bound to
/// `State::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 `State::NewFeature` is defined.
/// Specifically, when `state` represents `NewFeature`,
/// the execution path will hit the second last match arm as before by virtue of
/// calling `as_str` on `State::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.
///
/// <p>Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: <code>OFFLINE</code>, <code>ONLINE</code>, <code>STARTING</code>, <code>STOPPING</code>, <code>START_FAILED</code>, and <code>STOP_FAILED</code>.</p> <p> <code>OFFLINE</code> indicates that the server exists, but that it is not available for file operations. <code>ONLINE</code> indicates that the server is available to perform file operations. <code>STARTING</code> indicates that the server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both <code>START_FAILED</code> and <code>STOP_FAILED</code> are error conditions.</p>
#[non_exhaustive]
#[derive(
::std::clone::Clone, ::std::cmp::Eq, ::std::cmp::Ord, ::std::cmp::PartialEq, ::std::cmp::PartialOrd, ::std::fmt::Debug, ::std::hash::Hash,
)]
pub enum State {
#[allow(missing_docs)] // documentation missing in model
Offline,
#[allow(missing_docs)] // documentation missing in model
Online,
#[allow(missing_docs)] // documentation missing in model
Starting,
#[allow(missing_docs)] // documentation missing in model
StartFailed,
#[allow(missing_docs)] // documentation missing in model
Stopping,
#[allow(missing_docs)] // documentation missing in model
StopFailed,
/// `Unknown` contains new variants that have been added since this code was generated.
#[deprecated(note = "Don't directly match on `Unknown`. See the docs on this enum for the correct way to handle unknown variants.")]
Unknown(crate::primitives::sealed_enum_unknown::UnknownVariantValue),
}
impl ::std::convert::From<&str> for State {
fn from(s: &str) -> Self {
match s {
"OFFLINE" => State::Offline,
"ONLINE" => State::Online,
"STARTING" => State::Starting,
"START_FAILED" => State::StartFailed,
"STOPPING" => State::Stopping,
"STOP_FAILED" => State::StopFailed,
other => State::Unknown(crate::primitives::sealed_enum_unknown::UnknownVariantValue(other.to_owned())),
}
}
}
impl ::std::str::FromStr for State {
type Err = ::std::convert::Infallible;
fn from_str(s: &str) -> ::std::result::Result<Self, <Self as ::std::str::FromStr>::Err> {
::std::result::Result::Ok(State::from(s))
}
}
impl State {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
State::Offline => "OFFLINE",
State::Online => "ONLINE",
State::Starting => "STARTING",
State::StartFailed => "START_FAILED",
State::Stopping => "STOPPING",
State::StopFailed => "STOP_FAILED",
State::Unknown(value) => value.as_str(),
}
}
/// Returns all the `&str` representations of the enum members.
pub const fn values() -> &'static [&'static str] {
&["OFFLINE", "ONLINE", "STARTING", "START_FAILED", "STOPPING", "STOP_FAILED"]
}
}
impl ::std::convert::AsRef<str> for State {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl State {
/// Parses the enum value while disallowing unknown variants.
///
/// Unknown variants will result in an error.
pub fn try_parse(value: &str) -> ::std::result::Result<Self, crate::error::UnknownVariantError> {
match Self::from(value) {
#[allow(deprecated)]
Self::Unknown(_) => ::std::result::Result::Err(crate::error::UnknownVariantError::new(value)),
known => Ok(known),
}
}
}
impl ::std::fmt::Display for State {
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
match self {
State::Offline => write!(f, "OFFLINE"),
State::Online => write!(f, "ONLINE"),
State::Starting => write!(f, "STARTING"),
State::StartFailed => write!(f, "START_FAILED"),
State::Stopping => write!(f, "STOPPING"),
State::StopFailed => write!(f, "STOP_FAILED"),
State::Unknown(value) => write!(f, "{value}"),
}
}
}