Enum aws_sdk_comprehend::model::PiiEntitiesDetectionMode

#[non_exhaustive]
pub enum PiiEntitiesDetectionMode {
    OnlyOffsets,
    OnlyRedaction,
    Unknown(UnknownVariantValue),
}

When writing a match expression against PiiEntitiesDetectionMode, 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 piientitiesdetectionmode = unimplemented!();
match piientitiesdetectionmode {
    PiiEntitiesDetectionMode::OnlyOffsets => { /* ... */ },
    PiiEntitiesDetectionMode::OnlyRedaction => { /* ... */ },
    other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
    _ => { /* ... */ },
}

The above code demonstrates that when piientitiesdetectionmode represents NewFeature, the execution path will lead to the second last match arm, even though the enum does not contain a variant PiiEntitiesDetectionMode::NewFeature in the current version of SDK. The reason is that the variable other, created by the @ operator, is bound to PiiEntitiesDetectionMode::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 PiiEntitiesDetectionMode::NewFeature is defined. Specifically, when piientitiesdetectionmode represents NewFeature, the execution path will hit the second last match arm as before by virtue of calling as_str on PiiEntitiesDetectionMode::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.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

OnlyOffsets

OnlyRedaction

Unknown(UnknownVariantValue)

Unknown contains new variants that have been added since this code was generated.

Implementations

impl PiiEntitiesDetectionMode

pub fn as_str(&self) -> &str

Returns the &str value of the enum member.

Examples found in repository

src/model.rs (line 1736)

    fn as_ref(&self) -> &str {
        self.as_str()
    }

src/json_ser.rs (line 1270)

pub fn serialize_structure_crate_input_start_pii_entities_detection_job_input(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::input::StartPiiEntitiesDetectionJobInput,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_244) = &input.input_data_config {
        #[allow(unused_mut)]
        let mut object_245 = object.key("InputDataConfig").start_object();
        crate::json_ser::serialize_structure_crate_model_input_data_config(
            &mut object_245,
            var_244,
        )?;
        object_245.finish();
    }
    if let Some(var_246) = &input.output_data_config {
        #[allow(unused_mut)]
        let mut object_247 = object.key("OutputDataConfig").start_object();
        crate::json_ser::serialize_structure_crate_model_output_data_config(
            &mut object_247,
            var_246,
        )?;
        object_247.finish();
    }
    if let Some(var_248) = &input.mode {
        object.key("Mode").string(var_248.as_str());
    }
    if let Some(var_249) = &input.redaction_config {
        #[allow(unused_mut)]
        let mut object_250 = object.key("RedactionConfig").start_object();
        crate::json_ser::serialize_structure_crate_model_redaction_config(
            &mut object_250,
            var_249,
        )?;
        object_250.finish();
    }
    if let Some(var_251) = &input.data_access_role_arn {
        object.key("DataAccessRoleArn").string(var_251.as_str());
    }
    if let Some(var_252) = &input.job_name {
        object.key("JobName").string(var_252.as_str());
    }
    if let Some(var_253) = &input.language_code {
        object.key("LanguageCode").string(var_253.as_str());
    }
    if let Some(var_254) = &input.client_request_token {
        object.key("ClientRequestToken").string(var_254.as_str());
    }
    if let Some(var_255) = &input.tags {
        let mut array_256 = object.key("Tags").start_array();
        for item_257 in var_255 {
            {
                #[allow(unused_mut)]
                let mut object_258 = array_256.value().start_object();
                crate::json_ser::serialize_structure_crate_model_tag(&mut object_258, item_257)?;
                object_258.finish();
            }
        }
        array_256.finish();
    }
    Ok(())
}

pub const fn values() -> &'static [&'static str]

Returns all the &str values of the enum members.

Trait Implementations

impl AsRef<str> for PiiEntitiesDetectionMode

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PiiEntitiesDetectionMode

fn clone(&self) -> PiiEntitiesDetectionMode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PiiEntitiesDetectionMode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&str> for PiiEntitiesDetectionMode

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for PiiEntitiesDetectionMode

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for PiiEntitiesDetectionMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PiiEntitiesDetectionMode

fn cmp(&self, other: &PiiEntitiesDetectionMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<PiiEntitiesDetectionMode> for PiiEntitiesDetectionMode

fn eq(&self, other: &PiiEntitiesDetectionMode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<PiiEntitiesDetectionMode> for PiiEntitiesDetectionMode

fn partial_cmp(&self, other: &PiiEntitiesDetectionMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for PiiEntitiesDetectionMode

impl StructuralEq for PiiEntitiesDetectionMode

impl StructuralPartialEq for PiiEntitiesDetectionMode